koala 0.9.0 → 1.0.0.beta

data/spec/koala/typhoeus_service_tests.rb

@@ -0,0 +1,156 @@
+require 'koala/http_services'
+class TyphoeusServiceTests < Test::Unit::TestCase
+  module Bear
+    include Koala::TyphoeusService
+  end
+
+  describe "TyphoeusService module holder class Bear" do
+    before :each do
+      # reset the always_use_ssl parameter
+      Bear.always_use_ssl = nil
+    end
+
+    it "should define a make_request static module method" do
+      Bear.respond_to?(:make_request).should be_true
+    end
+
+    it "should include the Koala::HTTPService module defining common features" do
+      Bear.included_modules.include?(Koala::HTTPService).should be_true
+    end
+
+    describe "when making a request" do
+      before(:each) do
+        # Setup stubs for make_request to execute without exceptions
+        @mock_body = stub('Typhoeus response body')
+        @mock_headers_hash = stub({:value => "headers hash"})
+        @mock_http_response = stub(Typhoeus::Response, :code => 1, :headers_hash => @mock_headers_hash, :body => @mock_body)
+
+        # Typhoeus is an included module, so we stub methods on Bear itself
+        Bear.stub(:post).and_return(@mock_http_response)
+        Bear.stub(:get).and_return(@mock_http_response)
+      end
+
+      it "should use POST if verb is not GET" do
+        Bear.should_receive(:post).and_return(@mock_http_response)
+        Bear.make_request('anything', {}, 'anything')
+      end
+
+      it "should use GET if that verb is specified" do
+        Bear.should_receive(:get).and_return(@mock_http_response)
+        Bear.make_request('anything', {}, 'get')
+      end
+
+      describe "the connection" do
+        it "should use SSL if the request has an access token" do
+          Bear.should_receive(:post).with(/https\:/, anything)
+
+          Bear.make_request('anything', {"access_token" => "123"}, 'anything')
+        end
+
+        it "should use SSL if always_use_ssl is true, even if there's no token" do
+          Bear.should_receive(:post).with(/https\:/, anything)
+
+          Bear.always_use_ssl = true
+          Bear.make_request('anything', {}, 'anything')
+        end
+
+        it "should use SSL if the :use_ssl option is provided, even if there's no token" do
+          Bear.should_receive(:post).with(/https\:/, anything)
+
+          Bear.always_use_ssl = true
+          Bear.make_request('anything', {}, 'anything', :use_ssl => true)
+        end
+
+        it "should not use SSL if always_use_ssl is false and there's no token" do
+          Bear.should_receive(:post).with(/http\:/, anything)
+
+          Bear.make_request('anything', {}, 'anything')
+        end
+
+        it "should use the graph server by default" do
+          Bear.should_receive(:post).with(Regexp.new(Koala::Facebook::GRAPH_SERVER), anything)
+
+          Bear.make_request('anything', {}, 'anything')
+        end
+
+        it "should use the REST server if the :rest_api option is true" do
+          Bear.should_receive(:post).with(Regexp.new(Koala::Facebook::REST_SERVER), anything)
+
+          Bear.make_request('anything', {}, 'anything', :rest_api => true)
+        end
+      end
+
+      it "should pass the arguments to Typhoeus under the :params key" do
+        args = {:a => 2}
+        Bear.should_receive(:post).with(anything, hash_including(:params => args))
+
+        Bear.make_request('anything', args, "post")
+      end
+
+      it "should add the method to the arguments if the method isn't get or post" do
+        method = "telekenesis"
+        Bear.should_receive(:post).with(anything, hash_including(:params => {:method => method}))
+
+        Bear.make_request('anything', {}, method)
+      end
+
+      it "should pass :typhoeus_options to Typhoeus if provided" do
+        t_options = {:a => :b}
+        Bear.should_receive(:post).with(anything, hash_including(t_options))
+
+        Bear.make_request("anything", {}, "post", :typhoeus_options => t_options)
+      end
+
+      it "should include the path in the request" do
+        path = "/a/b/c/1"
+        Bear.should_receive(:post).with(Regexp.new(path), anything)
+
+        Bear.make_request(path, {}, "post")
+      end
+
+      describe "the returned value" do
+        before(:each) do
+          @response = Bear.make_request('anything', {}, 'anything')
+        end
+
+        it "should return a Koala::Response object" do
+          @response.class.should == Koala::Response
+        end
+
+        it "should return a Koala::Response with the right status" do
+          @response.status.should == @mock_http_response.code
+        end
+
+        it "should reutrn a Koala::Response with the right body" do
+          @response.body.should == @mock_body
+        end
+
+        it "should return a Koala::Response with the Net::HTTPResponse object as headers" do
+          @response.headers.should == @mock_headers_hash
+        end
+      end # describe return value
+    end
+    
+    describe "with file upload" do
+      it "should include an interface to NetHTTPService called NetHTTPInterface" do
+        # we should be able to access it
+        lambda { Koala::TyphoeusService::NetHTTPInterface }.should_not raise_exception(Exception)
+        Koala::TyphoeusService::NetHTTPInterface.included_modules.include?(Koala::NetHTTPService).should be_true
+      end
+      
+      it "should call the NetHTTPInterface if multipart is required" do
+        method = "any_method"
+        args = {}
+        verb = "get"
+        options = {}
+
+        Bear.stub(:params_require_multipart?).and_return(true)
+        Koala::TyphoeusService::NetHTTPInterface.should_receive(:make_request).with(method, args, verb, options)
+
+        Bear.make_request(method, args, verb, options)
+      end
+      
+      # for live tests, run the Graph API tests with Typhoues, which will run file uploads
+    end
+  end
+end

data/spec/koala_spec_helper.rb

@@ -1,6 +1,18 @@
-require 'test/unit'
-require 'rubygems'
-require 'spec/test/unit'
+if defined?(RUBY_VERSION) && RUBY_VERSION =~ /1\.9/
+  require 'test/unit'
+  require 'rspec'
+
+  Rspec.configure do |c|
+    c.mock_with :rspec
+  end
+
+else
+  # Ruby 1.8.x
+  require 'test/unit'
+  require 'rubygems'
+
+  require 'spec/test/unit'
+end
 
 # load the libraries
 require 'koala'
@@ -11,10 +23,12 @@ require 'koala/live_testing_data_helper'
 # API tests
 require 'koala/api_base_tests'
 
+require 'koala/graph_api/graph_api_tests'
 require 'koala/graph_api/graph_collection_tests'
 require 'koala/graph_api/graph_api_no_access_token_tests'
 require 'koala/graph_api/graph_api_with_access_token_tests'
 
+require 'koala/rest_api/rest_api_tests'
 require 'koala/rest_api/rest_api_no_access_token_tests'
 require 'koala/rest_api/rest_api_with_access_token_tests'
 
@@ -27,5 +41,30 @@ require 'koala/oauth/oauth_tests'
 # Subscriptions tests
 require 'koala/realtime_updates/realtime_updates_tests'
 
+# Test users tests
+require 'koala/test_users/test_users_tests'
+
 # Services tests
-require 'koala/net_http_service_tests'
+require 'koala/net_http_service_tests'
+begin
+  require 'koala/typhoeus_service_tests'
+rescue LoadError
+  puts "Typhoeus tests will not be run because Typhoeus is not installed."
+end
+
+module KoalaTest
+  def self.validate_user_info(token)
+    print "Validating permissions for live testing..."
+    # make sure we have the necessary permissions
+    api = Koala::Facebook::GraphAndRestAPI.new(token)
+    uid = api.get_object("me")["id"]
+    perms = api.fql_query("select read_stream, publish_stream, user_photos from permissions where uid = #{uid}")[0]
+    perms.each_pair do |perm, value| 
+      unless value == 1
+        puts "failed!\n" # put a new line after the print above
+        raise ArgumentError, "Your access token must have the read_stream, publish_stream, and user_photos permissions.  You have: #{perms.inspect}"
+      end
+    end
+    puts "done!"
+  end
+end

data/spec/koala_spec_without_mocks.rb

@@ -6,8 +6,6 @@ require 'koala_spec_helper'
 # specs to run.  See facebook_data.yml for more information.
 
 # load testing data (see note in readme.md)
-# I'm seeing a bug with spec and gets where the facebook_test_suite.rb file gets read in when gets is called
-# until that's solved, we'll need to store/update tokens in the access_token file
 $testing_data = YAML.load_file(File.join(File.dirname(__FILE__), 'facebook_data.yml')) rescue {}
 
 unless $testing_data["oauth_token"]
@@ -15,5 +13,7 @@ unless $testing_data["oauth_token"]
 end
 
 unless $testing_data["oauth_test_data"] && $testing_data["oauth_test_data"]["code"] && $testing_data["oauth_test_data"]["secret"]
-  puts "Cookie tests will fail until you store valid data for the cookie hash, app_id, and app secret in facebook_data.yml"
-end
+  puts "OAuth code tests will fail until you store valid data for the user's OAuth code and the app secret in facebook_data.yml"
+end
+
+KoalaTest.validate_user_info $testing_data["oauth_token"]

data/spec/mock_facebook_responses.yml

@@ -46,6 +46,10 @@ graph_api:
   # Subscription error response
   verification_error: &verification_error
     with_token: '{"error": {"type": "OAuthException", "message": "Error validating verification code."}}'
+    
+  test_user_no_perms: &test_user_no_perms
+    post:
+      with_token: '{"id": "777777777", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}'
       
 # -- Stubbed Responses --
   root:
@@ -78,7 +82,15 @@ graph_api:
     link=http://www.contextoptional.com/&message=Hello, world, from the test suite again!&name=Context Optional:
       post:
         with_token: '{"id": "FEED_ITEM_CONTEXT"}'
-        
+  /me/photos:
+    source=[FILE]:
+      post:
+        <<: *token_required
+        with_token: '{"id": "MOCK_PHOTO"}'
+    message=This is the test message&source=[FILE]:
+      post:
+        <<: *token_required
+        with_token: '{"id": "MOCK_PHOTO"}'
   /koppel:
     no_args:
       get:
@@ -233,9 +245,63 @@ graph_api:
   /FEED_ITEM_DELETE:
     no_args:
       <<: *item_deleted
-      
+
+  /FEED_ITEM_DELETE/likes:
+    no_args:
+      <<: *item_deleted
+      post: 
+        with_token: 'true'
+            
   /MOCK_COMMENT:
     no_args:
       <<: *item_deleted
       get:
-        with_token: "{\"message\": \"it\'s my comment!\"}"
+        with_token: "{\"message\": \"it\'s my comment!\"}"
+  /MOCK_PHOTO:
+    no_args:
+      <<: *item_deleted
+      get:
+        with_token: "{\"name\": \"This is the test message\"}"
+        
+# -- Mock Test User Responses --
+  /<%= APP_ID %>/accounts/test-users:
+    installed=false:
+      <<: *test_user_no_perms
+    installed=false&permissions=read_stream:
+      <<: *test_user_no_perms                                                                                                                                                            
+    installed=true&permissions=read_stream:
+      post:
+        with_token: '{"id": "999999999", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}'
+    installed=true&permissions=read_stream,user_interests:
+      post:
+        with_token: '{"id": "888888888", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}'
+    no_args:
+      get:
+        with_token: '{"data":[{"id": "999999999", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}, {"id": "888888888", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}]}'
+        
+  /999999999:
+    no_args:
+      <<: *item_deleted
+
+  /9999999991:
+    no_args:
+      delete:
+        with_token: '{"error": {"type": "OAuthException", "message": "Error validating verification code."}}'
+ 
+  /888888888:
+    no_args:
+      <<: *item_deleted   
+
+  /777777777:
+    no_args:
+      <<: *item_deleted
+
+  /999999999/friends/888888888:
+    no_args:
+      get:
+        with_token: 'true'
+      
+  /888888888/friends/999999999:
+    no_args:
+      get:
+        with_token: 'true'

data/spec/mock_http_service.rb

@@ -4,6 +4,7 @@ require 'yaml'
 module Koala
   module MockHTTPService
     # Mocks all HTTP requests for with koala_spec_with_mocks.rb
+    IS_MOCK = true # this lets our tests figure out if we want to stub methods
 
     # Mocked values to be included in TEST_DATA used in specs
     ACCESS_TOKEN = '*'
@@ -32,6 +33,8 @@ module Koala
     def self.included(base)
       base.class_eval do
         
+        include Koala::HTTPService
+        
         def self.make_request(path, args, verb, options = {})
           path = 'root' if path == '' || path == '/'
           verb ||= 'get'
@@ -42,7 +45,7 @@ module Koala
           args.delete('format')
           
           # Create a hash key for the arguments
-          args = args.empty? ? 'no_args' : args.sort{|a,b| a[0].to_s <=> b[0].to_s }.map{|arr| arr.join('=')}.join('&')
+          args = create_params_key(args)
           
           begin
             response = RESPONSES[server][path][args][verb][with_token]
@@ -75,6 +78,18 @@ module Koala
           response_object
         end
         
+        protected
+        def self.create_params_key(params_hash)
+          if params_hash.empty?
+            'no_args'
+          else
+            params_hash.sort{ |a,b| a[0].to_s <=> b[0].to_s}.map do |arr| 
+              arr[1] = '[FILE]' if arr[1].kind_of?(File) || is_valid_file_hash?(arr[1])
+              arr.join('=')
+            end.join('&')
+          end
+        end
+        
       end # class_eval
     end # included
   end

metadata

@@ -1,12 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: koala
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 31098193
+  prerelease: 6
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  - beta
+  version: 1.0.0.beta
 platform: ruby
 authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -14,10 +16,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 +02:00
+date: 2011-01-26 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
 description: Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph API and the older REST API, 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.
 email: alex@alexkoppel.com
 executables: []
@@ -32,25 +63,12 @@ extra_rdoc_files:
 - lib/koala/http_services.rb
 - lib/koala/realtime_updates.rb
 - lib/koala/rest_api.rb
+- lib/koala/test_users.rb
 files: 
 - CHANGELOG
 - LICENSE
 - Manifest
 - Rakefile
-- examples/oauth_playground/Capfile
-- examples/oauth_playground/LICENSE
-- examples/oauth_playground/Rakefile
-- examples/oauth_playground/config.ru
-- examples/oauth_playground/config/deploy.rb
-- examples/oauth_playground/config/facebook.yml
-- examples/oauth_playground/lib/load_facebook.rb
-- examples/oauth_playground/lib/oauth_playground.rb
-- examples/oauth_playground/readme.md
-- examples/oauth_playground/spec/oauth_playground_spec.rb
-- examples/oauth_playground/spec/spec_helper.rb
-- examples/oauth_playground/tmp/restart.txt
-- examples/oauth_playground/views/index.erb
-- examples/oauth_playground/views/layout.erb
 - init.rb
 - koala.gemspec
 - lib/koala.rb
@@ -58,12 +76,15 @@ files:
 - lib/koala/http_services.rb
 - lib/koala/realtime_updates.rb
 - lib/koala/rest_api.rb
+- lib/koala/test_users.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/live_testing_data_helper.rb
@@ -71,7 +92,10 @@ files:
 - 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/typhoeus_service_tests.rb
 - spec/koala_spec.rb
 - spec/koala_spec_helper.rb
 - spec/koala_spec_without_mocks.rb
@@ -87,21 +111,23 @@ rdoc_options:
 - --inline-source
 - --title
 - Koala
-- --main
-- readme.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
       segments: 
       - 1
       - 2
@@ -109,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: koala
-rubygems_version: 1.3.6
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A lightweight, flexible library for Facebook with support for the Graph API, the old REST API, realtime updates, and OAuth validation.

data/examples/oauth_playground/Capfile

@@ -1,2 +0,0 @@
-load 'deploy' if respond_to?(:namespace) # cap2 differentiator
-load 'config/deploy' # remove this line to skip loading any of the default tasks

data/examples/oauth_playground/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2010 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/examples/oauth_playground/Rakefile

@@ -1,4 +0,0 @@
-namespace :oauth_playground do
-  
-  
-end

data/examples/oauth_playground/config/deploy.rb

@@ -1,39 +0,0 @@
-set :application, "oauth_playground"
-set :repository,  "git://github.com/arsduo/oauth_playground.git"
-set :domain, "oauth.twoalex.com"
-set :deploy_to, "$HOME/rails_apps/#{application}/"
-
-# authentication
-set :scm, "git"
-set :user, "alexkm"
-set :use_sudo, false
-ssh_options[:forward_agent] = true
-
-# web server
-role :web, "oauth.twoalex.com"                          # Your HTTP server, Apache/etc
-role :app, "oauth.twoalex.com"                          # This may be the same as your `Web` server
-role :db,  "oauth.twoalex.com", :primary => true  # This is where Rails migrations will run
-
-
-# other git-related commands
-set :branch, "master"
-default_run_options[:pty] = true
-# cache the repository locally to speed updates
-set :repository_cache, "git_cache" 
-set :deploy_via, :remote_cache
-
-
-# passenger-specific deploy tasks
-namespace :deploy do
-  task :start do
-    run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
-  end
-  
-  task :stop do
-    # nothing
-  end
-  
-  task :restart, :roles => :app, :except => { :no_release => true } do
-    run "touch #{File.join(current_path,'tmp','restart.txt')}"
-  end
-end

data/examples/oauth_playground/config/facebook.yml

@@ -1,13 +0,0 @@
-development:
-  api_key: 171e3563d4fee42e0ba27450838bba32
-  secret_key: c81302ccef57cbdd2e68b2229e54cd2f
-  app_id: 119347844754245
-
-test:
-  api_key: 
-  secret_key: 
-
-production:
-  api_key: 25e1cec0df2b3bfa781da3ed78da3a1e
-  secret_key: e45e55a333eec232d4206d2703de1307
-  app_id: 119908831367602

data/examples/oauth_playground/config.ru

@@ -1,27 +0,0 @@
-# gems
-require 'sinatra'
-require 'logger'
-require 'yaml'
-
-# app files
-require 'koala'
-require File.join(File.dirname(__FILE__), 'lib', 'load_facebook.rb')
-require File.join(File.dirname(__FILE__), 'lib', 'oauth_playground.rb')
-
-# LOGGING
-# set up the logfile
-Dir.mkdir('log') unless File.exists?('log')
-log_filename = File.join(File.dirname(__FILE__), "log", "sinatra.log")
-log = File.new(log_filename, "a+")
-
-# log requests
-use Rack::CommonLogger, log 
-# log application-generated code
-LOGGER = Logger.new(log_filename) 
-# log output to stdout and stderr as well
-$stdout.reopen(log)
-$stderr.reopen(log)
-
-# activate the app
-disable :run
-run OAuthPlayground

data/examples/oauth_playground/lib/load_facebook.rb

@@ -1,3 +0,0 @@
-# load Facebook info for this environment
-FACEBOOK_INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..", "config", "facebook.yml"))[ENV["RACK_ENV"]]
-