tyler_koala 1.2.0beta

data/.autotest

@@ -0,0 +1,12 @@
+# Override autotest default magic to rerun all tests every time a
+# change is detected on the file system.
+class Autotest
+  
+  def get_to_green
+    begin
+      rerun_all_tests
+      wait_for_changes unless all_good
+    end until all_good
+  end
+                            
+end

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+.project
+Gemfile.lock
+.rvmrc
+*.rbc

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7 # (current default)
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx
+  - rbx-2.0
+  - ree
+  - jruby

data/CHANGELOG

@@ -0,0 +1,185 @@
+v1.2
+New methods:
+-- API is now the main API class, contains both Graph and REST methods
+  -- Old classes are aliased with deprecation warnings (non-breaking change)
+-- TestUsers#update lets you update the name or password of an existing test user
+-- GraphAPI.get_page_access_token lets you easily fetch the access token for a page you manage (thanks, marcgg!)
+Updated methods:
+-- put_picture now accepts URLs to images (thanks, marcgg!)
+Internal improvements:
+-- Koala now uses Faraday to make requests, replacing the HTTPServices (see wiki)
+  -- Koala::HTTPService.faraday_options allows specification of default Faraday connection options
+  -- Koala::HTTPService.faraday_middleware allows custom middleware configurations 
+-- RealTimeUpdates and TestUsers are no longer subclasses of API, but have their own .api objects
+  -- The old .graph_api accessor is aliases to .api with a deprecation warning
+Testing improvements:
+-- Live test suites now run against test users by default
+  -- Test suite can be repeatedly run live without having to update facebook_data.yml
+  -- OAuth code and session key tests cannot be run against test users
+-- Faraday adapter for live tests can be specified with ADAPTER=[your adapter] in the shell command
+-- Tests now pass against all rubies on Travis CI
+-- Expanded test coverage
+-- Fixed bug with YAML parsing in Ruby 1.9
+
+v1.1
+New methods:
+-- Added Batch API support (thanks, seejohnrun and spiegela!)
+  -- includes file uploads, error handling, and FQL
+-- Added GraphAPI#put_video
+-- Added GraphAPI#get_comments_for_urls (thanks, amrnt!)
+-- Added RestAPI#fql_multiquery, which simplifies the results (thanks, amrnt!)
+-- HTTP services support global proxy and timeout settings (thanks, itchy!)
+-- Net::HTTP supports global ca_path, ca_file, and verify_mode settings (thanks, spiegela!)
+Updated methods:
+-- RealtimeUpdates now uses a GraphAPI object instead of its own API
+-- RestAPI#rest_call now has an optional last argument for method, for calls requiring POST, DELETE, etc. (thanks, sshilo!)
+-- Filename can now be specified when uploading (e.g. for Ads API) (thanks, sshilo!)
+-- get_objects([]) returns [] instead of a Facebook error in non-batch mode (thanks, aselder!)
+Internal improvements:
+-- Koala is now more compatible with other Rubies (JRuby, Rubinius, etc.)
+-- HTTP services are more modular and can be changed on the fly (thanks, chadk!)
+  -- Includes support for uploading StringIOs and other non-files via Net::HTTP even when using TyphoeusService
+-- Koala now uses multi_json to improve compatibility with Rubinius and other Ruby versions
+-- Koala now uses the modern Typhoeus API (thanks, aselder!)
+-- Koala now uses the current modern Net::HTTP interface (thanks, romanbsd!)
+-- Fixed bugs and typos (thanks, waynn, mokevnin, and tikh!)
+
+v1.0
+New methods:
+-- Photo and file upload now supported through #put_picture
+  -- Added UploadableIO class to manage file uploads
+-- Added a delete_like method (thanks to waseem)
+-- Added put_connection and delete_connection convenience methods
+Updated methods:
+-- Search can now search places, checkins, etc. (thanks, rickyc!)
+-- You can now pass :beta => true in the http options to use Facebook's beta tier
+-- TestUser#befriend now requires user info hashes (id and access token) due to Facebook API changes (thanks, pulsd and kbighorse!)
+-- All methods now accept an http_options hash as their optional last parameter (thanks, spiegela!)
+-- url_for_oauth_code can now take a :display option (thanks, netbe!)
+-- Net::HTTP can now accept :timeout and :proxy options (thanks, gilles!)
+-- Test users now supports using test accounts across multiple apps
+Internal improvements:
+-- For public requests, Koala now uses http by default (instead of https) to improve speed
+  -- This can be overridden through Koala.always_use_ssl= or by passing :use_ssl => true in the options hash for an api call
+-- Read-only REST API requests now go through the faster api-read server
+-- Replaced parse_signed_request with a version from Facebook that also supports the new signed params proposal
+  -- Note: invalid requests will now raise exceptions rather than return nil, in keeping with other SDKs
+-- Delete methods will now raise an error if there's no access token (like put_object and delete_like)
+-- Updated parse_signed_request to match Facebook's current implementation (thanks, imajes!)
+-- APIError is now < StandardError, not Exception
+-- Added KoalaError for non-API errors
+-- Net::HTTP's SSL verification is no longer disabled by default
+Test improvements:
+-- Incorporated joshk's awesome rewrite of the entire Koala test suite (thanks, joshk!)
+-- Expanded HTTP service tests (added Typhoeus test suite and additional Net::HTTP test cases)
+-- Live tests now verify that the access token has the necessary permissions before starting
+-- Replaced the 50-person network test, which often took 15+ minutes to run live, with a 5-person test
+
+v0.10.0
+-- Added test user module
+-- Fixed bug when raising APIError after Facebook fails to exchange session keys
+-- Made access_token accessible via the readonly access_token property on all our API classes
+
+v0.9.1
+-- Tests are now compatible with Ruby 1.9.2
+-- Added JSON to runtime dependencies
+-- Removed examples directory (referenced from github instead)
+
+v0.9.0
+-- Added parse_signed_request to handle Facebook's new authentication scheme
+  -- note: creates dependency on OpenSSL (OpenSSL::HMAC) for decryption
+-- Added GraphCollection class to provide paging support for GraphAPI get_connections and search methods (thanks to jagthedrummer)
+-- Added get_page method to easily fetch pages of results from GraphCollections
+-- Exchanging sessions for tokens now works properly when provided invalid/expired session keys
+-- You can now include a :typhoeus_options key in TyphoeusService#make_request's options hash to control the Typhoeus call (for example, to set :disable_ssl_peer_verification => true)
+-- All paths provided to HTTP services start with leading / to improve compatibility with stubbing libraries
+-- If Facebook returns nil for search or get_connections requests, Koala now returns nil rather than throwing an exception
+
+v0.8.0
+-- Breaking interface changes
+  -- Removed string overloading for the methods, per 0.7.3, which caused Marshaling issues
+  -- Removed ability to provide a string as the second argument to url_for_access_token, per 0.5.0
+
+v0.7.4
+-- Fixed bug with get_user_from_cookies
+
+v0.7.3
+-- Added support for picture sizes -- thanks thhermansen for the patch!
+-- Adjusted the return values for several methods (get_access_token, get_app_access_token, get_token_from_session_key, get_tokens_from_session_keys, get_user_from_cookies)
+  -- These methods now return strings, rather than hashes, which makes more sense
+  -- The strings are overloaded with an [] method for backwards compatibility (Ruby is truly amazing)
+    -- Using those methods triggers a deprecation warning
+    -- This will be removed by 1.0
+  -- There are new info methods (get_access_token_info, get_app_access_token_info, get_token_info_from_session_keys, and get_user_info_from_cookies) that natively return hashes, for when you want the expiration date
+-- Responses with HTTP status 500+ now properly throw errors under Net::HTTP
+-- Updated changelog
+-- Added license
+
+v0.7.2
+-- Added support for exchanging session keys for OAuth access tokens (get_token_from_session_key for single keys, get_tokens_from_session_keys for multiple)
+-- Moved Koala files into a koala/ subdirectory to minimize risk of name collisions
+-- Added OAuth Playground git submodule as an example
+-- Updated tests, readme, and changelog
+
+v0.7.1
+-- Updated RealtimeUpdates#list_subscriptions and GraphAPI#get_connections to now return an
+array of results directly (rather than a hash with one key)
+-- Fixed a bug with Net::HTTP-based HTTP service in which the headers hash was improperly formatted
+-- Updated readme
+
+v0.7.0
+-- Added RealtimeUpdates class, which can be used to manage subscriptions for user updates (see http://developers.facebook.com/docs/api/realtime)
+-- Added picture method to graph API, which fetches an object's picture from the redirect headers.
+-- Added _greatly_ improved testing with result mocking, which is now the default set of tests
+-- Renamed live testing spec to koala_spec_without_mocks.rb
+-- Added Koala::Response class, which encapsulates HTTP results since Facebook sometimes sends data in the status or headers
+-- Much internal refactoring
+-- Updated readme, changelog, etc.
+
+
+v0.6.0
+-- Added support for the old REST API thanks to cbaclig's great work
+-- Updated tests to conform to RSpec standards
+-- Updated changelog, readme, etc.
+
+v0.5.1
+-- Documentation is now on the wiki, updated readme accordingly.
+
+v0.5.0
+-- Added several new OAuth methods for making and parsing access token requests
+-- Added test suite for the OAuth class
+-- Made second argument to url_for_access_token a hash (strings still work but trigger a deprecation warning)
+-- Added fields to facebook_data.yml
+-- Updated readme
+
+v0.4.1
+-- Encapsulated GraphAPI and OAuth classes in the Koala::Facebook module for clarity (and to avoid claiming the global Facebook class)
+-- Moved make_request method to Koala class from GraphAPI instance (for use by future OAuth class functionality)
+-- Renamed request method to api for consistancy with Javascript library
+-- Updated tests and readme
+
+v0.4.0
+-- Adopted the Koala name
+-- Updated readme and tests
+-- Fixed cookie verification bug for non-expiring OAuth tokens
+
+v0.3.1
+-- Bug fixes.
+
+v0.3
+-- Renamed Graph API class from Facebook::GraphAPI to FacebookGraph::API
+-- Created FacebookGraph::OAuth class for tokens and OAuth URLs
+-- Updated method for including HTTP service (think we've got it this time)
+-- Updated tests
+-- Added CHANGELOG and gemspec
+
+v0.2
+-- Gemified the project
+-- Split out HTTP services into their own file, and adjusted inclusion method
+
+v0.1
+-- Added modular support for Typhoeus
+-- Added tests
+
+v0.0
+-- Hi from F8!  Basic read/write from the graph is working

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+group :development, :test do
+  gem "typhoeus"
+end
+
+if defined? JRUBY_VERSION
+  gem "jruby-openssl"
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2010-2011 Alex Koppel
+
+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/Manifest

@@ -0,0 +1,39 @@
+CHANGELOG
+LICENSE
+Manifest
+Rakefile
+init.rb
+koala.gemspec
+lib/koala.rb
+lib/koala/graph_api.rb
+lib/koala/http_services.rb
+lib/koala/realtime_updates.rb
+lib/koala/rest_api.rb
+lib/koala/test_users.rb
+lib/koala/uploadable_io.rb
+readme.md
+spec/facebook_data.yml
+spec/koala/api_base_tests.rb
+spec/koala/assets/beach.jpg
+spec/koala/graph_and_rest_api/graph_and_rest_api_no_token_tests.rb
+spec/koala/graph_and_rest_api/graph_and_rest_api_with_token_tests.rb
+spec/koala/graph_api/graph_api_no_access_token_tests.rb
+spec/koala/graph_api/graph_api_tests.rb
+spec/koala/graph_api/graph_api_with_access_token_tests.rb
+spec/koala/graph_api/graph_collection_tests.rb
+spec/koala/http_services/http_service_tests.rb
+spec/koala/http_services/net_http_service_tests.rb
+spec/koala/http_services/typhoeus_service_tests.rb
+spec/koala/live_testing_data_helper.rb
+spec/koala/oauth/oauth_tests.rb
+spec/koala/realtime_updates/realtime_updates_tests.rb
+spec/koala/rest_api/rest_api_no_access_token_tests.rb
+spec/koala/rest_api/rest_api_tests.rb
+spec/koala/rest_api/rest_api_with_access_token_tests.rb
+spec/koala/test_users/test_users_tests.rb
+spec/koala/uploadable_io/uploadable_io_tests.rb
+spec/koala_spec.rb
+spec/koala_spec_helper.rb
+spec/koala_spec_without_mocks.rb
+spec/mock_facebook_responses.yml
+spec/mock_http_service.rb

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--color", '--format doc']
+end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/koala.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name    = %q{tyler_koala}
+  s.version = "1.2.0beta"
+  s.date    = %q{2011-07-16}
+
+  s.summary     = %q{A lightweight, flexible library for Facebook with support for the Graph API, the REST API, realtime updates, and OAuth authentication.}
+  s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph and REST APIs, as well as support for realtime updates and OAuth and Facebook Connect authentication.  Koala is fully tested and supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.}
+  s.homepage    = %q{http://github.com/arsduo/koala}
+
+  s.authors = ["Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional"]
+  s.email   = %q{alex@alexkoppel.com}
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.extra_rdoc_files = ["readme.md", "CHANGELOG"]
+  s.rdoc_options     = ["--line-numbers", "--inline-source", "--title", "Koala"]
+
+  s.require_paths     = ["lib"]
+
+  s.rubygems_version  = %q{1.4.2}
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multi_json>,      ["~> 1.0"])
+      s.add_runtime_dependency(%q<faraday>,  ["~> 0.7.4"])
+      s.add_runtime_dependency(%q<faraday-stack>,  ["~> 0.1.3"])
+      s.add_development_dependency(%q<rspec>,     ["~> 2.5"])
+      s.add_development_dependency(%q<rake>,      ["~> 0.8.7"])
+    else
+      s.add_dependency(%q<multi_json>,      ["~> 1.0"])
+      s.add_dependency(%q<rspec>,     ["~> 2.5"])
+      s.add_dependency(%q<rake>,      ["~> 0.8.7"])
+      s.add_dependency(%q<faraday>,  ["~> 0.7.4"])
+      s.add_dependency(%q<faraday-stack>,  ["~> 0.1.3"])
+    end
+  else
+    s.add_dependency(%q<multi_json>,      ["~> 1.0"])
+    s.add_dependency(%q<rspec>,     ["~> 2.5"])
+    s.add_dependency(%q<rake>,      ["~> 0.8.7"])
+    s.add_dependency(%q<faraday>,  ["~> 0.7.4"])
+    s.add_dependency(%q<faraday-stack>,  ["~> 0.1.3"])
+  end
+end

data/lib/koala.rb

@@ -0,0 +1,119 @@
+require 'cgi'
+require 'digest/md5'
+
+require 'multi_json'
+
+# OpenSSL and Base64 are required to support signed_request
+require 'openssl'
+require 'base64'
+
+# include koala modules
+require 'koala/http_service'
+require 'koala/oauth'
+require 'koala/graph_api'
+require 'koala/graph_batch_api'
+require 'koala/batch_operation'
+require 'koala/graph_collection'
+require 'koala/rest_api'
+require 'koala/realtime_updates'
+require 'koala/test_users'
+require 'koala/utils'
+
+# add KoalaIO class
+require 'koala/uploadable_io'
+
+module Koala
+
+  module Facebook
+    # Ruby client library for the Facebook Platform.
+    # Copyright 2010-2011 Alex Koppel
+    # Contributors: Alex Koppel, Chris Baclig, Rafi Jacoby, and the team at Context Optional
+    # http://github.com/arsduo/koala
+
+    # APIs
+    class API
+      # initialize with an access token
+      def initialize(access_token = nil)
+        @access_token = access_token
+      end
+      attr_reader :access_token
+
+      include GraphAPIMethods
+      include RestAPIMethods
+
+      def api(path, args = {}, verb = "get", options = {}, &error_checking_block)
+        # Fetches the given path in the Graph API.
+        args["access_token"] = @access_token || @app_access_token if @access_token || @app_access_token
+
+        # add a leading /
+        path = "/#{path}" unless path =~ /^\//
+
+        # make the request via the provided service
+        result = Koala.make_request(path, args, verb, options)
+
+        # Check for any 500 errors before parsing the body
+        # since we're not guaranteed that the body is valid JSON
+        # in the case of a server error
+        raise APIError.new({"type" => "HTTP #{result.status.to_s}", "message" => "Response body: #{result.body}"}) if result.status >= 500
+
+        # parse the body as JSON and run it through the error checker (if provided)
+        # Note: Facebook sometimes sends results like "true" and "false", which aren't strictly objects
+        # and cause MultiJson.decode to fail -- so we account for that by wrapping the result in []
+        body = MultiJson.decode("[#{result.body.to_s}]")[0]
+        yield body if error_checking_block
+
+        # if we want a component other than the body (e.g. redirect header for images), return that
+        options[:http_component] ? result.send(options[:http_component]) : body
+      end
+    end
+
+    # special enhanced APIs
+    class GraphBatchAPI < API
+      include GraphBatchAPIMethods
+    end
+
+    class RealtimeUpdates
+      include RealtimeUpdateMethods
+    end
+
+    class TestUsers
+      include TestUserMethods
+    end
+
+    # legacy support for old APIs
+    class OldAPI < API;
+      def initialize(*args)
+        Koala::Utils.deprecate("#{self.class.name} is deprecated and will be removed in a future version; please use the API class instead.")
+        super
+      end
+    end
+    class GraphAPI < OldAPI; end
+    class RestAPI < OldAPI; end
+    class GraphAndRestAPI < OldAPI; end
+
+    # Errors
+
+    class APIError < StandardError
+      attr_accessor :fb_error_type
+      def initialize(details = {})
+        self.fb_error_type = details["type"]
+        super("#{fb_error_type}: #{details["message"]}")
+      end
+    end
+  end
+
+  class KoalaError < StandardError; end
+
+
+  # finally, the few things defined on the Koala module itself
+  class << self
+    attr_accessor :http_service
+  end
+
+  def self.make_request(path, args, verb, options = {})
+    http_service.make_request(path, args, verb, options)
+  end
+
+  # we use Faraday as our main service, with mock as the other main one
+  self.http_service = HTTPService
+end