koala 1.0.0 → 1.2.0

data/spec/cases/http_services/net_http_service_spec.rb

@@ -1,350 +0,0 @@
-require 'spec_helper'
-
-
-module Horse
-  include Koala::NetHTTPService
-end
-
-describe "NetHTTPService module holder class Horse" do
-  before :each do
-    # reset the always_use_ssl parameter
-    Horse.always_use_ssl = nil
-  end
-
-  it "should define a make_request static module method" do
-    Horse.respond_to?(:make_request).should be_true
-  end
-
-  it "should include the Koala::HTTPService module defining common features" do
-    Horse.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_http_response = stub('Net::HTTPResponse', :code => 1)
-      @mock_body = stub('Net::HTTPResponse body')
-      @http_request_result = [@mock_http_response, @mock_body]
-
-      # to_ary is called in Ruby 1.9 to provide backwards compatibility
-      # with the response, body = http.get() syntax we use
-      @mock_http_response.stub!(:to_ary).and_return(@http_request_result)
-
-      @http_yield_mock = mock('Net::HTTP start yielded object')
-
-      @http_yield_mock.stub(:post).and_return(@http_request_result)
-      @http_yield_mock.stub(:get).and_return(@http_request_result)
-
-      @http_mock = stub('Net::HTTP object', 'use_ssl=' => true, 'verify_mode=' => true)
-      @http_mock.stub(:start).and_yield(@http_yield_mock)
-
-      Net::HTTP.stub(:new).and_return(@http_mock)
-    end
-
-    describe "the connection" do
-      it "should use POST if verb is not GET" do
-        @http_yield_mock.should_receive(:post).and_return(@mock_http_response)
-        @http_mock.should_receive(:start).and_yield(@http_yield_mock)
-
-        Horse.make_request('anything', {}, 'anything')
-      end
-
-      it "should use GET if that verb is specified" do
-        @http_yield_mock.should_receive(:get).and_return(@mock_http_response)
-        @http_mock.should_receive(:start).and_yield(@http_yield_mock)
-
-        Horse.make_request('anything', {}, 'get')
-      end
-
-      it "should add the method to the arguments if it's not get or post" do
-        args = {}
-        method = "telekenesis"
-        # since the arguments get encoded later, we'll test for merge!
-        # even though that's somewhat testing internal implementation
-        args.should_receive(:merge!).with(:method => method)
-
-        Horse.make_request('anything', args, method)
-      end
-    end
-
-    describe "if the request has an access token" do
-      before :each do
-        @args = {"access_token" => "123"}
-      end
-
-      it "should use SSL" do
-        @http_mock.should_receive('use_ssl=').with(true)
-
-        Horse.make_request('anything', @args, 'anything')
-      end
-
-      it "should set the port to 443" do
-        Net::HTTP.should_receive(:new).with(anything, 443).and_return(@http_mock)
-
-        Horse.make_request('anything', @args, 'anything')
-      end
-    end
-    
-    describe "if always_use_ssl is true" do
-      before :each do
-        Horse.always_use_ssl = true
-      end
-
-      it "should use SSL" do
-        @http_mock.should_receive('use_ssl=').with(true)
-
-        Horse.make_request('anything', {}, 'anything')
-      end
-
-      it "should set the port to 443" do
-        Net::HTTP.should_receive(:new).with(anything, 443).and_return(@http_mock)
-
-        Horse.make_request('anything', {}, 'anything')
-      end
-    end
-
-    describe "if the use_ssl option is provided" do
-      it "should use SSL" do
-        @http_mock.should_receive('use_ssl=').with(true)
-
-        Horse.make_request('anything', {}, 'anything', :use_ssl => true)
-      end
-
-      it "should set the port to 443" do
-        Net::HTTP.should_receive(:new).with(anything, 443).and_return(@http_mock)
-
-        Horse.make_request('anything', {}, 'anything', :use_ssl => true)
-      end
-    end
-
-    describe "if there's no token and always_use_ssl isn't true" do
-      it "should not use SSL" do
-        @http_mock.should_not_receive('use_ssl=')
-        Horse.make_request('anything', {}, 'anything')
-      end
-
-      it "should not set the port" do
-        Net::HTTP.should_receive(:new).with(anything, nil).and_return(@http_mock)
-        Horse.make_request('anything', {}, 'anything')
-      end
-    end
-
-    it "should use the graph server by default" do
-      Net::HTTP.should_receive(:new).with(Koala::Facebook::GRAPH_SERVER, anything).and_return(@http_mock)
-      Horse.make_request('anything', {}, 'anything')
-    end
-
-    it "should use the REST server if the :rest_api option is true" do
-      Net::HTTP.should_receive(:new).with(Koala::Facebook::REST_SERVER, anything).and_return(@http_mock)
-      Horse.make_request('anything', {}, 'anything', :rest_api => true)
-    end
-
-    it "no longer sets verify_mode to no verification" do
-      @http_mock.should_not_receive('verify_mode=')
-
-      Horse.make_request('anything', {}, 'anything')
-    end
-
-    it "should start an HTTP connection" do
-      @http_mock.should_receive(:start).and_yield(@http_yield_mock)
-      Horse.make_request('anything', {}, 'anything')
-    end
-    
-    it 'creates a HTTP Proxy object when options contain a proxy' do
-      Net::HTTP.should_receive(:new).with(anything, anything, 'proxy', 1234, 'user', 'pass').and_return(@http_mock)
-      Horse.make_request('anything', {}, 'anything', {:proxy => 'http://user:pass@proxy:1234'})
-    end
-
-    it 'sets both timeouts when options contains a timeout' do
-      @http_mock.should_receive(:open_timeout=).with(10)
-      @http_mock.should_receive(:read_timeout=).with(10)
-      Horse.make_request('anything', {}, 'anything', {:timeout => 10})
-    end
-
-    describe "via POST" do
-      it "should use Net::HTTP to make a POST request" do
-        @http_yield_mock.should_receive(:post).and_return(@http_request_result)
-
-        Horse.make_request('anything', {}, 'post')
-      end
-
-      it "should go to the specified path adding a / if it doesn't exist" do
-        path = mock('Path')
-        @http_yield_mock.should_receive(:post).with(path, anything).and_return(@http_request_result)
-
-        Horse.make_request(path, {}, 'post')
-      end
-
-      it "should use encoded parameters" do
-        args = {}
-        params = mock('Encoded parameters')
-        Horse.should_receive(:encode_params).with(args).and_return(params)
-
-        @http_yield_mock.should_receive(:post).with(anything, params).and_return(@http_request_result)
-
-        Horse.make_request('anything', args, 'post')
-      end
-
-      describe "with multipart/form-data" do
-        before(:each) do
-          Horse.stub(:encode_multipart_params)
-          Horse.stub("params_require_multipart?").and_return(true)
-
-          @multipart_request_stub = stub('Stub Multipart Request')
-          Net::HTTP::Post::Multipart.stub(:new).and_return(@multipart_request_stub)
-
-          @file_stub = stub('fake File', "kind_of?" => true, "path" => 'anypath.jpg')
-
-          @http_yield_mock.stub(:request).with(@multipart_request_stub).and_return(@http_request_result)
-        end
-
-        it "should use multipart/form-data if any parameter is a valid file hash" do
-          @http_yield_mock.should_receive(:request).with(@multipart_request_stub).and_return(@http_request_result)
-
-          Horse.make_request('anything', {}, 'post')
-        end
-
-        it "should use the given request path for the request" do
-          args = {"file" => @file_stub}
-          expected_path = 'expected/path'
-
-          Net::HTTP::Post::Multipart.should_receive(:new).with(expected_path, anything).and_return(@multipart_request_stub)
-
-          Horse.make_request(expected_path, {}, 'post')
-        end
-
-        it "should use multipart encoded arguments for the request" do
-          args = {"file" => @file_stub}
-          expected_params = stub('Stub Multipart Params')
-
-          Horse.should_receive(:encode_multipart_params).with(args).and_return(expected_params)
-          Net::HTTP::Post::Multipart.should_receive(:new).with(anything, expected_params).and_return(@multipart_request_stub)
-
-          Horse.make_request('anything', args, 'post')
-        end
-      end
-    end
-
-    describe "via GET" do
-      it "should use Net::HTTP to make a GET request" do
-        @http_yield_mock.should_receive(:get).and_return(@http_request_result)
-
-        Horse.make_request('anything', {}, 'get')
-      end
-
-      it "should use the correct path, including arguments" do
-        path = mock('Path')
-        params = mock('Encoded parameters')
-        args = {}
-
-        Horse.should_receive(:encode_params).with(args).and_return(params)
-        @http_yield_mock.should_receive(:get).with("#{path}?#{params}").and_return(@http_request_result)
-
-        Horse.make_request(path, args, 'get')
-      end
-    end
-
-    describe "the returned value" do
-      before(:each) do
-        @response = Horse.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_http_response
-      end
-    end # describe return value
-  end # describe when making a request
-
-  describe "when encoding parameters" do
-    it "should return an empty string if param_hash evaluates to false" do
-      Horse.encode_params(nil).should == ''
-    end
-
-    it "should convert values to JSON if the value is not a String" do
-      val = 'json_value'
-      not_a_string = 'not_a_string'
-      not_a_string.stub(:class).and_return('NotAString')
-      not_a_string.should_receive(:to_json).and_return(val)
-
-      string = "hi"
-
-      args = {
-        not_a_string => not_a_string,
-        string => string
-      }
-
-      result = Horse.encode_params(args)
-      result.split('&').find do |key_and_val|
-        key_and_val.match("#{not_a_string}=#{val}")
-      end.should be_true
-    end
-
-    it "should escape all values" do
-      args = Hash[*(1..4).map {|i| [i.to_s, "Value #{i}($"]}.flatten]
-
-      result = Horse.encode_params(args)
-      result.split('&').each do |key_val|
-        key, val = key_val.split('=')
-        val.should == CGI.escape(args[key])
-      end
-    end
-
-    it "should convert all keys to Strings" do
-      args = Hash[*(1..4).map {|i| [i, "val#{i}"]}.flatten]
-
-      result = Horse.encode_params(args)
-      result.split('&').each do |key_val|
-        key, val = key_val.split('=')
-        key.should == args.find{|key_val_arr| key_val_arr.last == val}.first.to_s
-      end
-    end
-  end
-
-  describe "when detecting if multipart posting is needed" do
-    it "should be true if any parameter value requires multipart post" do
-      koala_io = mock("Koala::IO")
-      koala_io.should_receive(:kind_of?).with(Koala::UploadableIO).and_return(true)
-
-      args = {
-        "key1" => "val",
-        "key2" => "val",
-        "key3" => koala_io,
-        "key4" => "val"
-      }
-
-      Horse.params_require_multipart?(args).should be_true
-    end
-    
-    describe "when encoding multipart/form-data params" do
-      it "should replace Koala::UploadableIO values with UploadIO values" do
-        upload_io = UploadIO.new(__FILE__, "fake type")
-        
-        uploadable_io = stub('Koala::UploadableIO')
-        uploadable_io.should_receive(:kind_of?).with(Koala::UploadableIO).and_return(true)
-        uploadable_io.should_receive(:to_upload_io).and_return(upload_io)
-        args = {
-          "not_a_file" => "not a file",
-          "file" => uploadable_io
-        }
-        
-        result = Horse.encode_multipart_params(args)
-
-        result["not_a_file"] == args["not_a_file"]
-        result["file"] == upload_io
-      end
-    end
-    
-  end
-end

data/spec/cases/http_services/typhoeus_service_spec.rb

@@ -1,144 +0,0 @@
-require 'spec_helper'
-
-
-module Deer
-  include Koala::TyphoeusService
-end
-
-describe "TyphoeusService" do
-
-  describe "TyphoeusService module holder class Deer" do
-    before :each do
-      # reset the always_use_ssl parameter
-      Deer.always_use_ssl = nil
-    end
-
-    it "should define a make_request static module method" do
-      Deer.respond_to?(:make_request).should be_true
-    end
-
-    it "should include the Koala::HTTPService module defining common features" do
-      Deer.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 Deer itself
-        Deer.stub(:post).and_return(@mock_http_response)
-        Deer.stub(:get).and_return(@mock_http_response)
-      end
-
-      it "should use POST if verb is not GET" do
-        Deer.should_receive(:post).and_return(@mock_http_response)
-        Deer.make_request('anything', {}, 'anything')
-      end
-
-      it "should use GET if that verb is specified" do
-        Deer.should_receive(:get).and_return(@mock_http_response)
-        Deer.make_request('anything', {}, 'get')
-      end
-
-      describe "the connection" do
-        it "should use SSL if the request has an access token" do
-          Deer.should_receive(:post).with(/https\:/, anything)
-
-          Deer.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
-          Deer.should_receive(:post).with(/https\:/, anything)
-
-          Deer.always_use_ssl = true
-          Deer.make_request('anything', {}, 'anything')
-        end
-
-        it "should use SSL if the :use_ssl option is provided, even if there's no token" do
-          Deer.should_receive(:post).with(/https\:/, anything)
-
-          Deer.always_use_ssl = true
-          Deer.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
-          Deer.should_receive(:post).with(/http\:/, anything)
-
-          Deer.make_request('anything', {}, 'anything')
-        end
-
-        it "should use the graph server by default" do
-          Deer.should_receive(:post).with(Regexp.new(Koala::Facebook::GRAPH_SERVER), anything)
-
-          Deer.make_request('anything', {}, 'anything')
-        end
-
-        it "should use the REST server if the :rest_api option is true" do
-          Deer.should_receive(:post).with(Regexp.new(Koala::Facebook::REST_SERVER), anything)
-
-          Deer.make_request('anything', {}, 'anything', :rest_api => true)
-        end
-      end
-
-      it "should pass the arguments to Typhoeus under the :params key" do
-        args = {:a => 2}
-        Deer.should_receive(:post).with(anything, hash_including(:params => args))
-
-        Deer.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"
-        Deer.should_receive(:post).with(anything, hash_including(:params => {:method => method}))
-
-        Deer.make_request('anything', {}, method)
-      end
-
-      it "should pass :typhoeus_options to Typhoeus if provided" do
-        t_options = {:a => :b}
-        Deer.should_receive(:post).with(anything, hash_including(t_options))
-
-        Deer.make_request("anything", {}, "post", :typhoeus_options => t_options)
-      end
-      
-      # for live tests, run the Graph API tests with Typhoues, which will run file uploads
-      it "should pass any files directly on to Typhoues" do
-        args = {:file => File.new(__FILE__, "r")}
-        Deer.should_receive(:post).with(anything, hash_including(:params => args)).and_return(Typhoeus::Response.new)
-        Deer.make_request("anything", args, :post)
-      end
-
-      it "should include the path in the request" do
-        path = "/a/b/c/1"
-        Deer.should_receive(:post).with(Regexp.new(path), anything)
-
-        Deer.make_request(path, {}, "post")
-      end
-
-      describe "the returned value" do
-        before(:each) do
-          @response = Deer.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 Typhoeus headers as headers" do
-          @response.headers.should == @mock_headers_hash
-        end
-      end # describe return value
-    end
-  end
-end

data/spec/support/live_testing_data_helper.rb

@@ -1,40 +0,0 @@
-module LiveTestingDataHelper
-  # in RSpec 2, included example groups no longer share any hooks or state with outside examples
-  # even if in the same block
-  # so we have to use a module to provide setup and teardown hooks for live testing
-
-  def self.included(base)
-    base.class_eval do
-      before :each do
-        @token = $testing_data["oauth_token"]
-        raise Exception, "Must supply access token to run FacebookWithAccessTokenTests!" unless @token
-        # track temporary objects created
-        @temporary_object_ids = []
-      end
-
-      after :each do
-        # clean up any temporary objects
-        @temporary_object_ids << @temporary_object_id if @temporary_object_id
-        count = @temporary_object_ids.length
-        errors = []
-
-        if count > 0
-          @temporary_object_ids.each do |id|
-            # get our API
-            api = @api || (@test_users ? @test_users.graph_api : nil)
-            raise "Unable to locate API when passed temporary object to delete!" unless api
-
-            # delete the object
-            result = (api.delete_object(id) rescue false)
-            # if we errored out or Facebook returned false, track that
-            errors << id unless result
-          end
-
-          unless errors.length == 0
-            puts "cleaned up #{count - errors.length} objects, but errored out on the following:\n #{errors.join(", ")}"
-          end
-        end
-      end
-    end
-  end
-end

data/spec/support/setup_mocks_or_live.rb

@@ -1,52 +0,0 @@
-# small helper method for live testing
-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
-
-
-unless ENV['LIVE']
-  # By default the Koala specs are run using stubs for HTTP requests
-  #
-  # Valid OAuth token and code are not necessary to run these
-  # specs.  Because of this, specs do not fail due to Facebook
-  # imposed rate-limits or server timeouts.
-  #
-  # However as a result they are more brittle since
-  # we are not testing the latest responses from the Facebook servers.
-  # Therefore, to be certain all specs pass with the current
-  # Facebook services, run koala_spec_without_mocks.rb.
-  Koala.http_service = Koala::MockHTTPService
-
-  $testing_data = Koala::MockHTTPService::TEST_DATA
-else
-  # Runs Koala specs through the Facebook servers
-  #
-  # Note that you need a valid OAuth token and code for these
-  # specs to run.  See facebook_data.yml for more information.
-
-  # load testing data (see note in readme.md)
-  $testing_data = YAML.load_file(File.join(File.dirname(__FILE__), '../fixtures/facebook_data.yml'))
-
-  unless $testing_data["oauth_token"]
-    puts "Access token tests will fail until you store a valid token in facebook_data.yml"
-  end
-
-  unless $testing_data["oauth_test_data"] && $testing_data["oauth_test_data"]["code"] && $testing_data["oauth_test_data"]["secret"]
-    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"]
-end