fb-core 0.0.0 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e7cf77685db56762493294c58103f63598c109f
-  data.tar.gz: dda64de17fb9f2754cbb4c3efd30b7d72e4de1ef
+  metadata.gz: a13a49371c7ccfc542e43e7d7fce1ea8117e572c
+  data.tar.gz: cd5a65c87114f4619267c7d623460088a630aa6f
 SHA512:
-  metadata.gz: acbbd981745168be505bea860172a75bf2d4715e0a234bce625f8f5d7b3e58e8f61937fe7fe961f5768a7f28d5465e68686bb8824e187cda7f10987650ccb13b
-  data.tar.gz: 8896365d2820399d8dd91288f500aec155e1dc3e12aaa1d657025aa69c42101ca26ea316019b9e9cc68534e596f657d2168dffd38682fdab53d1258b0d61c2ff
+  metadata.gz: fea2337106ce89df4378c733dd712e0a5e6f72bf1e91a02170bd5c9d8e63eedfb81102945a13845f507a9a3c31ebefd82eb179aca58de1a8d3c5bfbdc2490642
+  data.tar.gz: e947bc2aca68b388e937ccfee36c986dd715b1a438054d996561ee16f89c41aff21d2ce6d40de808732d59be76c72df5faad034de1f5c14fa4e69dd78fa5ca8d

data/.gitignore

@@ -7,3 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

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

data/.travis.yml

@@ -1,3 +1,8 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.2.2
+  - 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,12 @@
+# 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/07/24
+
+* [FEATURE] Added `Fb::User`
+* [FEATURE] Added `Fb::Page`

data/Gemfile

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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 claudiob
+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

data/README.md

@@ -1,3 +1,57 @@
 # Fb::Core
 
-:star: :star: :star:
+Fb::Core provides methods to interact with Facebook users and pages through the Facebook Graph API.
+
+[![Build Status](http://img.shields.io/travis/Fullscreen/fb-core/master.svg)](https://travis-ci.org/Fullscreen/fb-core)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/fb-core/master.svg)](https://coveralls.io/r/Fullscreen/fb-core)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/fb-core.svg)](https://gemnasium.com/Fullscreen/fb-core)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/fb-core.svg)](https://codeclimate.com/github/Fullscreen/fb-core)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/fb-core/frames)
+[![Gem Version](http://img.shields.io/gem/v/fb-core.svg)](http://rubygems.org/gems/fb-core)
+
+The **source code** is available on [GitHub](https://github.com/Fullscreen/fb-core) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/fb-core/frames).
+
+### Installing and Configuring
+
+Add `fb-core` to your Gemfile and run `bundle install`.
+
+Most methods of this library require to have an access token of a Facebook user.
+If you need to obtain one programmatically, use the [fb-auth](https://github.com/Fullscreen/fb-auth) library.
+
+## Usage
+
+Fb::User#email
+--------------
+
+Given an user access token with the `email` scope, you can get the user's email by calling:
+
+```ruby
+user = Fb::User.new access_token: '--valid-access-token--'
+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:
+
+```ruby
+user = Fb::User.new access_token: '--valid-access-token--'
+user.pages
+# => [#<Fb::Page: id="1234", name="sample1">, #<Fb::Page: id="5678", name="sample2">]
+```
+
+## Development
+
+To run tests, obtain a long-term access token for a Facebook user who manages
+at least one page and includes `email` and `manage_pages` scopes. Set the token as:
+
+    export FB_TEST_ACCESS_TOKEN="YourToken"
+
+Then, run `rake spec` to run the tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Thanks :tada:

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "fb-core"
+require "fb/core"
 
 # 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.
@@ -11,4 +11,4 @@ require "fb-core"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
+set -vx
 
 bundle install
 

data/fb-core.gemspec

@@ -1,25 +1,32 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'Fb/Core/version'
+require 'fb/core/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fb-core"
+  spec.name          = 'fb-core'
   spec.version       = Fb::Core::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
+  spec.authors       = ['Claudio Baccigalupo']
+  spec.email         = ['claudio@fullscreen.net']
 
-  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/fullscreen/fb-core"
-  spec.license       = "MIT"
+  spec.summary       = %q{Ruby client to interact with Facebook Graph API.}
+  spec.description   = %q{Fb::Core provides methods to interact with User and
+    Pages through the Facebook Graph API.}
+  spec.homepage      = 'https://github.com/Fullscreen/fb-core'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_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/core.rb

@@ -0,0 +1,8 @@
+require 'fb/support'
+require 'fb/page'
+require 'fb/user'
+
+# An object-oriented Ruby client for the Facebook Graph API.
+# @see http://www.rubydoc.info/gems/fb-core/
+module Fb
+end

data/lib/fb/core/version.rb

@@ -1,5 +1,8 @@
 module Fb
-  module Core
-    VERSION = "0.0.0"
+  # Provides basic functionality to connect to the Facebook Graph API.
+  class Core
+    # @return [String] the SemVer-compatible gem version.
+    # @see http://semver.org
+    VERSION = '1.0.0.alpha1'
   end
 end

data/lib/fb/page.rb

@@ -0,0 +1,29 @@
+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
+    # @option [String] the page’s unique ID.
+    attr_reader :id
+
+    # @option [String] the page’s name.
+    attr_reader :name
+
+    # @option [String] the page’s category.
+    attr_reader :category
+
+    # @param [Hash] options to initialize a Page object.
+    # @option [String] :id The page’s unique ID.
+    # @option [String] :name The page’s name.
+    # @option [String] :category The page’s category.
+    def initialize(options = {})
+      @id = options[:id]
+      @name = options[:name]
+      @category = options[:category]
+    end
+
+    # @return [String] the representation of the page.
+    def to_s
+      %Q(#<#{self.class.name} #{@id} "#{@name}">)
+    end
+  end
+end

data/lib/fb/user.rb

@@ -0,0 +1,39 @@
+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
+    # @param [Hash] options to initialize a User object.
+    # @option [String] :access_token an access token for the user.
+    def initialize(options = {})
+      @access_token = options[:access_token]
+    end
+
+    # @return [String] the user’s email address.
+    def email
+      @email ||= begin
+        params = {fields: :email, access_token: @access_token}
+        request = HTTPRequest.new path: '/me', params: params
+        request.run.body['email']
+      end
+    end
+
+    # @return [Array<Fb::Page>] the pages managed by the user.
+    def pages
+      @pages ||= begin
+        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)
+        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,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fb-core
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
-- claudiob
+- Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-24 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: :development
+  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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,15 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Write a longer description or delete this line.
+- !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::Core provides methods to interact with User and
+      Pages through the Facebook Graph API.
 email:
-- claudiob@gmail.com
+- claudio@fullscreen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -54,10 +115,11 @@ files:
 - bin/console
 - bin/setup
 - fb-core.gemspec
-- lib/fb-core.rb
+- lib/fb/core.rb
 - lib/fb/core/version.rb
-- yt-auth-0.0.0.gem
-homepage: https://github.com/fullscreen/fb-core
+- lib/fb/page.rb
+- lib/fb/user.rb
+homepage: https://github.com/Fullscreen/fb-core
 licenses:
 - MIT
 metadata: {}
@@ -72,13 +134,13 @@ 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
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because Rubygems requires one.
+summary: Ruby client to interact with Facebook Graph API.
 test_files: []

data/lib/fb-core.rb

@@ -1,3 +0,0 @@
-module Fb::Core
-  # Your code goes here...
-end