facebook-client 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+# Ignore the _creds.rb spec file
+spec/_creds.rb
+
+# Ignore tempfiles
+*.sw[op]
+.DS_Store
+
+# RVM
+.rvmrc
+
+# Gems
+*.gem
+
+# IDEs
+.idea
+.project

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--backtrace
+--require rspec/instafail
+--format RSpec::Instafail

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+#gem 'saddle', :path => '../saddle'
+gem 'saddle', '~> 0.0.38'
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2'
+end
+
+group :development, :test do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.10)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    i18n (0.6.4)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multipart-post (1.2.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.1)
+    saddle (0.0.38)
+      activesupport (>= 3.0)
+      faraday (~> 0.8.7)
+      faraday_middleware (~> 0.9.0)
+    slop (3.4.6)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec (~> 2.14.1)
+  rspec-instafail (~> 0.2)
+  saddle (~> 0.0.38)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013, Airbnb
+
+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,17 @@
+# Ruby Facebook OAuth2 client
+
+
+## Usage
+
+    client = Facebook::Client.create(
+      :oauth2_access_token => YOUR_USER_ACCESS_TOKEN
+    )
+    user = client.people.me
+    user = client.people.by_id(123)
+
+    data = client.fql.query('SELECT name FROM user WHERE uid = me()')
+
+
+## License
+(c) Airbnb 2013
+Released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/facebook-client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/facebook-client/version', __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'facebook-client'
+  s.version       = ::Facebook::VERSION
+  s.authors       = ['Mike Lewis']
+  s.email         = ['mike.lewis@airbnb.com']
+  s.description   = %q{Facebook OAuth2 client}
+  s.summary       = %q{
+    This is a Facebook OAuth2 client implemented on Saddle
+  }
+  s.homepage      = 'https://github.com/airbnb/facebook-client'
+  s.license       = 'MIT'
+
+  s.require_path  = 'lib'
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'saddle', '~> 0.0.38'
+end

data/lib/facebook-client.rb

@@ -0,0 +1,42 @@
+require 'saddle'
+require 'saddle/middleware/authentication/oauth2'
+
+require 'facebook-client/exceptions'
+require 'facebook-client/middleware/exception_raiser'
+require 'facebook-client/version'
+
+
+
+module Facebook
+
+  class Client < Saddle::Client
+
+    def self.host
+      'graph.facebook.com'
+    end
+
+    def self.use_ssl
+      true
+    end
+
+    def self.num_retries
+      1
+    end
+
+    def self.timeout
+      5 # seconds
+    end
+
+
+    add_middleware({
+      :klass => Middleware::ExceptionRaiser,
+    })
+
+    add_middleware({
+      :klass => Saddle::Middleware::Authentication::OAuth2,
+      :args => ['access_token'],
+    })
+
+  end
+
+end

data/lib/facebook-client/endpoints/fql.rb

@@ -0,0 +1,17 @@
+require 'saddle/endpoint'
+
+
+
+module Facebook
+  module Endpoints
+
+    class FQL < Saddle::TraversalEndpoint
+
+      def query(q, opts = {})
+        get(nil, {'q' => q}, opts)['data']
+      end
+
+    end
+
+  end
+end

data/lib/facebook-client/endpoints/user.rb

@@ -0,0 +1,33 @@
+require 'saddle/endpoint'
+
+
+
+module Facebook
+  module Endpoints
+
+    class User < Saddle::TraversalEndpoint
+
+      ABSOLUTE_PATH = ''
+
+      def me(opts = {})
+        by_id('me', opts)
+      end
+
+      def by_id(_id, opts = {})
+        get(_id, opts_to_params(opts), opts)
+      end
+
+
+      private
+
+      # Put useful params out of the opts
+      def opts_to_params(opts)
+        params = {}
+        params['fields'] = opts[:fields].map(&:to_s).join(',') if opts[:fields]
+        params
+      end
+
+    end
+
+  end
+end

data/lib/facebook-client/exceptions.rb

@@ -0,0 +1,86 @@
+
+##
+# Exceptions for using the Facebook client
+# It is recommended that you handle these.
+##
+
+module Facebook
+
+  class GenericException < StandardError; end
+
+  class TimeoutError < GenericException; end
+
+  # Some problems might take care of themselves if you try again later. Others won't.
+  class TemporaryError < GenericException; end # fire warnings on these
+  class PermanentError < GenericException; end # fire errors on these
+
+
+  # Error codes are based upon:
+  # http://fbdevwiki.com/wiki/Error_codes#Error_Code_Table
+
+  # And for the record, this page is LIES:
+  #  https://developers.facebook.com/docs/reference/api/errors/
+  # Do not trust it.
+
+  # (0-99) General Errors
+  class GeneralError < GenericException; end
+  ## (2) Service temporarily unavailable
+  class ServiceError < GeneralError; end
+  ## (3) Unknown method
+  class UnknownMethodError < GeneralError; end
+  ## (4, 18) Application request limit reached
+  class RequestLimitError < GeneralError; end
+  ## (9, 17) User is performing too many actions
+  class UserRequestLimitError < RequestLimitError; end
+  ## (10) Application does not have permission for this action
+  class ApplicationPermissionError < GeneralError; end
+  ## (11) This method is deprecated
+  class MethodDeprecatedError < GeneralError; end
+
+  # (100-199) Parameter Errors
+  class ParameterError < GenericException; end
+  ## (101) Invalid API key
+  class InvalidAPIKeyError < ParameterError; end
+  ## (102) Session key invalid or no longer valid
+  class InvalidSessionKeyError < ParameterError; end
+  ## (190) Invalid OAuth 2.0 Access Token
+  class InvalidAccessTokenError < ParameterError; end
+
+  # (200-299) User Permission Errors
+  class UserPermissionError < GenericException; end
+  ## (200) Permissions error
+  class PermissionError < UserPermissionError; end
+  ## (210) User not visible
+  class UserNotVisibleError < UserPermissionError; end
+  ## (212) Renewing a session offline requires the extended permission offline_access
+  class OfflineAccessPermissionError < UserPermissionError; end
+
+  # (300-399) Data Editing Errors
+  class DataEditingError < GenericException; end
+
+  # (400-449) Authentication Errors
+  class AuthenticationError < GenericException; end
+
+  # (450-455) Session Errors
+  class SessionError < GenericException; end
+
+  # (500-599) Application Messaging Errors
+  class ApplicationMessagingError < GenericException; end
+
+  # (600-699) FQL Errors
+  class FQLError < GenericException; end
+
+  # (700-749) Ref Errors
+  class RefError < GenericException; end
+
+  # (750-799) Application Integration Errors
+  class ApplicationIntegrationError < GenericException; end
+
+  # (900-949) Application Information Errors
+  class ApplicationInformationError < GenericException; end
+
+  # (950-999) Batch API Errors
+  class BatchAPIError < GenericException; end
+
+  # ... There's more. Include when needed.
+end

data/lib/facebook-client/middleware/exception_raiser.rb

@@ -0,0 +1,97 @@
+require 'faraday'
+
+require 'facebook-client/exceptions'
+
+
+
+module Facebook
+  module Middleware
+
+    ## Raise beautiful exceptions
+    #
+    class ExceptionRaiser < Faraday::Middleware
+
+      ## For handling errors, the message that gets returned is of the following format:
+      # {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Faraday::Error::ClientError => e
+          # Error codes are based upon:
+          # http://fbdevwiki.com/wiki/Error_codes#Error_Code_Table
+          fb_error_code = e.response[:body].try(:[], 'error').try(:[], 'code')
+
+          # Translate our error code into an exception
+          exception =
+            case fb_error_code
+            ## (0-99) General Errors
+            when 2
+              Facebook::ServiceError
+            when 3
+              Facebook::UnknownMethodError
+            when 4, 18, 9, 17
+              Facebook::RequestLimitError
+            when 10
+              Facebook::ApplicationPermissionError
+            when 11
+              Facebook::MethodDeprecatedError
+            when 0..99
+              Facebook::GeneralError
+            ## (100-199) Parameter Errors
+            when 101
+              Facebook::InvalidAPIKeyError
+            when 102
+              Facebook::InvalidSessionKeyError
+            when 190
+              Facebook::InvalidAccessTokenError
+            when 100..199
+              Facebook::ParameterError
+            ## (200-299) User Permission Errors
+            when 200
+              Facebook::PermissionError
+            when 212
+              Facebook::OfflineAccessPermissionError
+            when 200..299
+              Facebook::UserPermissionError
+            ## (300-399) Data Editing Errors
+            when 300..399
+              Facebook::DataEditingError
+            ## (400-449) Authentication Errors
+            when 400..449
+              Facebook::AuthenticationError
+            ## (450-455) Session Errors
+            when 450..455
+              Facebook::SessionError
+            ## (500-599) Application Messaging Errors
+            when 500..599
+              Facebook::ApplicationMessagingError
+            ## (600-699) FQL Errors
+            when 600..699
+              Facebook::FQLError
+            ## (700-749) Ref Errors
+            when 700..749
+              Facebook::RefError
+            ## (750-799) Application Integration Errors
+            when 750..799
+              Facebook::ApplicationIntegrationError
+            ## (900-949) Application Information Errors
+            when 900..949
+              Facebook::ApplicationInformationError
+            ## (950-999) Batch API Errors
+            when 950..999
+              Facebook::BatchAPIError
+            else
+              Facebook::GenericException
+            end
+
+          raise exception, e.response
+        rescue Saddle::TimeoutError => e
+          raise Facebook::TimeoutError, e.response
+        end
+      end
+
+    end
+
+  end
+end

data/lib/facebook-client/version.rb

@@ -0,0 +1,3 @@
+module Facebook
+  VERSION = '0.0.1'
+end

data/spec/_creds.stub.rb

@@ -0,0 +1 @@
+TEST_ACCESS_TOKEN = 'XXX_YOUR_OAUTH2_ACCESS_TOKEN_XXX'

data/spec/integration/fql_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+
+###
+# NOTE: This spec will actually hit Facebook's servers
+###
+
+describe 'Facebook::Endpoints::FQL' do
+  context "Test integration of FQL endpoints" do
+
+    # Skip if the creds aren't setup
+    if defined?(TEST_ACCESS_TOKEN)
+
+      before :each do
+        @client = Facebook::Client.create(:access_token => TEST_ACCESS_TOKEN)
+      end
+
+      it 'should get self info' do
+        @client.fql.query('SELECT name FROM user WHERE uid = me()').should_not be_nil
+      end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/integration/user_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+
+###
+# NOTE: This spec will actually hit Facebook's servers
+###
+
+describe 'Facebook::Endpoints::User' do
+  context "Test integration of user endpoints" do
+
+    # Skip if the creds aren't setup
+    if defined?(TEST_ACCESS_TOKEN)
+
+      before :each do
+        @client = Facebook::Client.create(:access_token => TEST_ACCESS_TOKEN)
+      end
+
+      it 'should get self profile' do
+        @client.user.me.should be_a(Hash)
+      end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/middleware/exception_raiser_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+
+describe Facebook::Middleware::ExceptionRaiser do
+
+  describe "Test raising various exceptions using stubs" do
+
+    before :each do
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @client = Facebook::Client.create(:stubs => @stubs)
+    end
+
+
+    it 'should detect a service error' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 2 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::ServiceError)
+    end
+
+    it 'should detect throttling' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 9 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::RequestLimitError)
+    end
+
+    it 'should detect invalid access tokens' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 190 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::InvalidAccessTokenError)
+    end
+
+    it 'should detect permission errors' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 200 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::PermissionError)
+    end
+
+    it 'should detect offline access permission errors' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 212 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::OfflineAccessPermissionError)
+    end
+
+    it 'should detect general user permission errors' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 249 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::UserPermissionError)
+    end
+
+    it 'should detect FQL errors' do
+      @stubs.get('/') { [ 400, {}, { 'error' => { 'code' => 600 } } ] }
+      expect { @client.requester.get('') }.to raise_error(Facebook::FQLError)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'facebook-client'
+
+
+# Load credentials from ENV if possible, or load from _creds.rb
+if ENV['TEST_ACCESS_TOKEN']
+  TEST_ACCESS_TOKEN = ENV['TEST_ACCESS_TOKEN']
+else
+  begin
+    require '_creds'
+  rescue LoadError
+    puts "Using _creds.stub.rb, create a _creds.rb with actual credentials for a live test."
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: facebook-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: saddle
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.38
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.38
+description: Facebook OAuth2 client
+email:
+- mike.lewis@airbnb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- facebook-client.gemspec
+- lib/facebook-client.rb
+- lib/facebook-client/endpoints/fql.rb
+- lib/facebook-client/endpoints/user.rb
+- lib/facebook-client/exceptions.rb
+- lib/facebook-client/middleware/exception_raiser.rb
+- lib/facebook-client/version.rb
+- spec/_creds.stub.rb
+- spec/integration/fql_spec.rb
+- spec/integration/user_spec.rb
+- spec/middleware/exception_raiser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/airbnb/facebook-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This is a Facebook OAuth2 client implemented on Saddle
+test_files:
+- spec/_creds.stub.rb
+- spec/integration/fql_spec.rb
+- spec/integration/user_spec.rb
+- spec/middleware/exception_raiser_spec.rb
+- spec/spec_helper.rb