g5_facebook_api_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d30689b1584cbb10798078becb15afb9c1005ee
+  data.tar.gz: 7f7e47bc55b70cfaf581154a8ca5feefe9e4d36e
+SHA512:
+  metadata.gz: ea1e7513f3f374d29291fb14f60aa3987c4324682dbdf16d2830f6b22f3afcd9aa3d86c198959debf068361c4c90734e0322f53ba8de2b9b5eaec56b1da1a5af
+  data.tar.gz: 26825321c5c3b740d9fd9b168256c238da68fca48fc775242614ce58b6c42e8365273b8050414c1c892a921409f4b183827cff72091127cab5eaa213bb180d31

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bbauer
+
+MIT License
+
+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,60 @@
+# G5 Facebook Api Client
+
+[![Gem Version](https://badge.fury.io/rb/g5_facebook_api_client.svg)](http://badge.fury.io/rb/g5_facebook_api_client)
+[![Build Status](https://travis-ci.org/G5/g5_facebook_api_client.svg?branch=master)](https://travis-ci.org/G5/g5_facebook_api_client.svg?branch=master)
+
+Facebook Graph API Ruby client for G5 apps
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'g5_facebook_api_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install g5_facebook_api_client
+
+
+## Usage
+
+```client_id``` and ```client_secret``` parameters can either be passed to
+the class on instantiation, or set as ```ENV["FACEBOOK_ID"]``` and ```ENV["FACEBOOK_SECRET"]```.
+
+##### User Permissions
+
+
+```ruby
+user = G5FacebookApiClient::User.new("client_id", "client_secret")
+user.permissions
+```
+
+##### Page Feed
+
+
+```ruby
+page = G5FacebookApiClient::Page.new("page_id", "client_id", "client_secret")
+page.posts
+```
+
+##### Page Insights
+
+
+```ruby
+# Coming Soon
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/g5_facebook_api_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/g5_facebook_api_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'g5_facebook_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "g5_facebook_api_client"
+  spec.version       = G5FacebookApiClient::VERSION
+  spec.authors       = ["bbauer"]
+  spec.email         = ["brian.bauer@g5platform.com"]
+  spec.summary       = %q{Facebook Graph Api Client}
+  spec.description   = %q{Facebook Graph Api Client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "pry"
+end

data/lib/g5_facebook_api_client/access_token.rb

@@ -0,0 +1,16 @@
+class G5FacebookApiClient::AccessToken < G5FacebookApiClient::Base
+  RESOURCE = "oauth/access_token"
+
+  def fetch
+    get(access_token_uri)
+  end
+
+  private
+
+  def access_token_uri
+    "#{G5FacebookApiClient::ENDPOINT}/#{RESOURCE}" \
+    "?client_id=#{@client_id}&client_secret=#{@client_secret}" \
+    "&grant_type=client_credentials"
+  end
+end
+

data/lib/g5_facebook_api_client/base.rb

@@ -0,0 +1,28 @@
+class G5FacebookApiClient::Base
+  def initialize(client_id=nil, client_secret=nil)
+    @client_id = client_id || ENV["FACEBOOK_ID"]
+    @client_secret = client_secret || ENV["FACEBOOK_SECRET"]
+  end
+
+  def access_token
+    @access_token ||=
+      G5FacebookApiClient::AccessToken.new(@client_id, @client_secret).fetch
+  end
+
+  def parse(body)
+    JSON.parse(body)
+  end
+
+  def get(url)
+    HTTParty.get(encode(url)).body
+  end
+
+  def post(url)
+    HTTParty.post(encode(url)).body
+  end
+
+  def encode(string)
+    URI::encode(string)
+  end
+end
+

data/lib/g5_facebook_api_client/insights.rb

@@ -0,0 +1,32 @@
+class G5FacebookApiClient::Insights < G5FacebookApiClient::Base
+  RESOURCE = "insights"
+
+  def initialize(page, client_id=nil, client_secret=nil)
+    @page = page
+    @client_id = client_id || ENV["FACEBOOK_ID"]
+    @client_secret = client_secret || ENV["FACEBOOK_SECRET"]
+  end
+
+  def page_likes
+    parse(request(resource("page_fans_locale/lifetime")))
+  end
+
+  def page_views
+    parse(request(resource("page_views")))
+  end
+
+  def page_impressions
+    parse(request(resource("page_impressions")))
+  end
+
+  private
+
+  def resource(metric)
+    "#{@page}/#{RESOURCE}/#{metric}?#{access_token}"
+  end
+
+  def request(resource)
+    get("#{G5FacebookApiClient::BASE_URI}/#{resource}")
+  end
+end
+

data/lib/g5_facebook_api_client/page.rb

@@ -0,0 +1,28 @@
+class G5FacebookApiClient::Page < G5FacebookApiClient::Base
+  LIMIT = 20
+
+  def initialize(page, client_id=nil, client_secret=nil)
+    @page = page
+    @client_id = client_id || ENV["FACEBOOK_ID"]
+    @client_secret = client_secret || ENV["FACEBOOK_SECRET"]
+  end
+
+  def posts
+    parse(get(posts_uri))
+  end
+
+  private
+
+  def posts_uri
+    "#{G5FacebookApiClient::ENDPOINT}/#{@page}/#{feed_parameters}&#{default_parameters}"
+  end
+
+  def default_parameters
+    "limit=#{LIMIT}&#{access_token}"
+  end
+
+  def feed_parameters
+    "posts?fields=likes.limit(1).summary(true),shares,message,id,created_time,from"
+  end
+end
+

data/lib/g5_facebook_api_client/user.rb

@@ -0,0 +1,12 @@
+class G5FacebookApiClient::User < G5FacebookApiClient::Base
+  def permissions
+    parse(get("#{user_uri}/permissions?#{access_token}"))
+  end
+
+  private
+
+  def user_uri
+    "#{G5FacebookApiClient::ENDPOINT}/#{@client_id}"
+  end
+end
+

data/lib/g5_facebook_api_client/version.rb

@@ -0,0 +1,3 @@
+module G5FacebookApiClient
+  VERSION = "0.0.1"
+end

data/lib/g5_facebook_api_client.rb

@@ -0,0 +1,15 @@
+require "httparty"
+require "pry"
+require "g5_facebook_api_client/base"
+require "g5_facebook_api_client/version"
+require "g5_facebook_api_client/page"
+require "g5_facebook_api_client/insights"
+require "g5_facebook_api_client/user"
+require "g5_facebook_api_client/access_token"
+
+module G5FacebookApiClient
+  ENDPOINT    = "https://graph.facebook.com"
+  API_VERSION = "v2.2"
+  BASE_URI    = "#{ENDPOINT}/#{API_VERSION}"
+end
+

data/spec/fixtures/vcr_cassettes/access_token.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://graph.facebook.com/oauth/access_token?client_id=121584141274833&client_secret=b0d3826624470f5f5c3e70ce70893ed4&grant_type=client_credentials
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Facebook-Api-Version:
+      - v1.0
+      Content-Type:
+      - text/plain; charset=UTF-8
+      Pragma:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Fb-Rev:
+      - '1528169'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      X-Fb-Debug:
+      - tB3Fleg4WIvUptu40ZoA1j9SBXJIzxgwDNSJNcWwNWF/VSDTEbakK+ySXdKdB19AMziXPTQOxkej7kg4qvmCwQ==
+      Date:
+      - Thu, 11 Dec 2014 17:19:21 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '56'
+    body:
+      encoding: UTF-8
+      string: access_token=121584141274833|EzolJusCGWQEJt_mnLvlo7Jiz_Q
+    http_version: 
+  recorded_at: Thu, 11 Dec 2014 17:19:22 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/access_token_invalid_client_id.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://graph.facebook.com/oauth/access_token?client_id=foo&client_secret=b0d3826624470f5f5c3e70ce70893ed4&grant_type=client_credentials
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Www-Authenticate:
+      - OAuth "Facebook Platform" "unknown_error" "An unknown error has occurred."
+      Facebook-Api-Version:
+      - v1.0
+      Content-Type:
+      - application/json; charset=UTF-8
+      Pragma:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Fb-Rev:
+      - '1527549'
+      Cache-Control:
+      - no-store
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      X-Fb-Debug:
+      - G/zykKfupeCmp1VhZfdqYo59PH2+uRAf/q0xSFimU6E94ULP5J/DjKs8zV0W6XrtKpz/DtldekHmkZyNZJ0Sew==
+      Date:
+      - Thu, 11 Dec 2014 17:20:49 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '87'
+    body:
+      encoding: UTF-8
+      string: '{"error":{"message":"An unknown error has occurred.","type":"OAuthException","code":1}}'
+    http_version: 
+  recorded_at: Thu, 11 Dec 2014 17:20:50 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/access_token_invalid_client_secret.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://graph.facebook.com/oauth/access_token?client_id=121584141274833&client_secret=bar&grant_type=client_credentials
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Www-Authenticate:
+      - OAuth "Facebook Platform" "invalid_request" "Error validating client secret."
+      Facebook-Api-Version:
+      - v1.0
+      Content-Type:
+      - application/json; charset=UTF-8
+      Pragma:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Fb-Rev:
+      - '1528169'
+      Cache-Control:
+      - no-store
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      X-Fb-Debug:
+      - Y+WGNa7VKxKQKg+ex4ifCRysyyKXexUJmjdz6TCrn6JpSvSv7S+UZxEJKTLVb9U0lLPDdVw3bOKC1FxpWQz3gQ==
+      Date:
+      - Thu, 11 Dec 2014 17:21:56 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '88'
+    body:
+      encoding: UTF-8
+      string: '{"error":{"message":"Error validating client secret.","type":"OAuthException","code":1}}'
+    http_version: 
+  recorded_at: Thu, 11 Dec 2014 17:21:58 GMT
+recorded_with: VCR 2.9.3