koala 0.9.0 → 1.1.0

data/spec/support/rest_api_shared_examples.rb

@@ -0,0 +1,285 @@
+shared_examples_for "Koala RestAPI" do
+  # REST_CALL
+  describe "when making a rest request" do
+    it "should use the proper path" do
+      method = stub('methodName')
+      @api.should_receive(:api).with(
+        "method/#{method}",
+        anything,
+        anything,
+        anything
+      )
+
+      @api.rest_call(method)
+    end
+
+    it "should always use the rest api" do
+      @api.should_receive(:api).with(
+        anything,
+        anything,
+        anything,
+        hash_including(:rest_api => true)
+      )
+
+      @api.rest_call('anything')
+    end
+
+    it "should set the read_only option to true if the method is listed in the read-only list" do
+      method = Koala::Facebook::RestAPI::READ_ONLY_METHODS.first
+
+      @api.should_receive(:api).with(
+        anything,
+        anything,
+        anything,
+        hash_including(:read_only => true)
+      )
+
+      @api.rest_call(method)
+    end
+
+    it "should set the read_only option to false if the method is not inthe read-only list" do
+      method = "I'm not a read-only method"
+
+      @api.should_receive(:api).with(
+        anything,
+        anything,
+        anything,
+        hash_including(:read_only => false)
+      )
+
+      @api.rest_call(method)
+    end
+
+
+    it "should take an optional hash of arguments" do
+      args = {:arg1 => 'arg1'}
+
+      @api.should_receive(:api).with(
+        anything,
+        hash_including(args),
+        anything,
+        anything
+      )
+
+      @api.rest_call('anything', args)
+    end
+
+    it "should always ask for JSON" do
+      @api.should_receive(:api).with(
+        anything,
+        hash_including('format' => 'json'),
+        anything,
+        anything
+      )
+
+      @api.rest_call('anything')
+    end
+
+    it "should pass any options provided to the API" do
+      options = {:a => 2}
+
+      @api.should_receive(:api).with(
+        anything,
+        hash_including('format' => 'json'),
+        anything,
+        hash_including(options)
+      )
+
+      @api.rest_call('anything', {}, options)
+    end
+    
+    it "uses get by default" do
+      @api.should_receive(:api).with(
+        anything,
+        anything,
+        "get",
+        anything
+      )
+
+      @api.rest_call('anything')
+    end
+    
+    it "allows you to specify other http methods as the last argument" do
+      method = 'bar'
+      @api.should_receive(:api).with(
+        anything,
+        anything,
+        method,
+        anything
+      )
+
+      @api.rest_call('anything', {}, {}, method)
+    end
+
+    it "should throw an APIError if the result hash has an error key" do
+      Koala.stub(:make_request).and_return(Koala::Response.new(500, {"error_code" => "An error occurred!"}, {}))
+      lambda { @api.rest_call("koppel", {}) }.should raise_exception(Koala::Facebook::APIError)
+    end
+
+    describe "when making a FQL request" do
+      it "should call fql.query method" do
+        @api.should_receive(:rest_call).with(
+          "fql.query", anything, anything
+        ).and_return(Koala::Response.new(200, "2", {}))
+
+        @api.fql_query stub('query string')
+      end
+
+      it "should pass a query argument" do
+        query = stub('query string')
+
+        @api.should_receive(:rest_call).with(
+          anything, hash_including(:query => query), anything
+        )
+
+        @api.fql_query(query)
+      end
+      
+      it "should pass on any other arguments provided" do
+        args = {:a => 2}
+        @api.should_receive(:rest_call).with(anything, hash_including(args), anything)
+        @api.fql_query("a query", args)
+      end
+      
+      it "should pass on any http options provided" do
+        opts = {:a => 2}
+        @api.should_receive(:rest_call).with(anything, anything, hash_including(opts))
+        @api.fql_query("a query", {}, opts)
+      end
+    end
+    
+    describe "when making a FQL-multiquery request" do
+      it "should call fql.multiquery method" do
+        @api.should_receive(:rest_call).with(
+          "fql.multiquery", anything, anything
+        ).and_return({})
+
+        @api.fql_multiquery 'query string'
+      end
+
+      it "should pass a queries argument" do
+        queries = stub('query string')
+        queries_json = "some JSON"
+        MultiJson.stub(:encode).with(queries).and_return(queries_json)
+        
+        @api.should_receive(:rest_call).with(
+          anything,
+          hash_including(:queries => queries_json),
+          anything
+        )
+
+        @api.fql_multiquery(queries)
+      end
+      
+      it "simplifies the response format" do
+        raw_results = [
+          {"name" => "query1", "fql_result_set" => [1, 2, 3]},
+          {"name" => "query2", "fql_result_set" => [:a, :b, :c]}
+        ]
+        expected_results = {
+          "query1" => [1, 2, 3],
+          "query2" => [:a, :b, :c]
+        }
+        
+        @api.stub(:rest_call).and_return(raw_results)
+        results = @api.fql_multiquery({:query => true})
+        results.should == expected_results
+      end
+      
+      it "should pass on any other arguments provided" do
+        args = {:a => 2}
+        @api.should_receive(:rest_call).with(anything, hash_including(args), anything)
+        @api.fql_multiquery("a query", args)
+      end
+      
+      it "should pass on any http options provided" do
+        opts = {:a => 2}
+        @api.should_receive(:rest_call).with(anything, anything, hash_including(opts))
+        @api.fql_multiquery("a query", {}, opts)
+      end
+    end
+  end
+end
+
+shared_examples_for "Koala RestAPI with an access token" do
+  # FQL
+  it "should be able to access public information via FQL" do
+    result = @api.fql_query('select first_name from user where uid = 216743')
+    result.size.should == 1
+    result.first['first_name'].should == 'Chris'
+  end
+
+  it "should be able to access public information via FQL.multiquery" do
+    result = @api.fql_multiquery(
+      :query1 => 'select first_name from user where uid = 216743',
+      :query2 => 'select first_name from user where uid = 2905623'
+    )
+    result.size.should == 2
+    result["query1"].first['first_name'].should == 'Chris'
+    result["query2"].first['first_name'].should == 'Alex'
+  end
+
+  it "should be able to access protected information via FQL" do
+    # Tests agains the permissions fql table
+
+    # get the current user's ID
+    # we're sneakily using the Graph API, which should be okay since it has its own tests
+    g = Koala::Facebook::GraphAPI.new(@token)
+    id = g.get_object("me", :fields => "id")["id"]
+
+    # now send a query about your permissions
+    result = @api.fql_query("select read_stream from permissions where uid = #{id}")
+
+    result.size.should == 1
+    # we've verified that you have read_stream permissions, so we can test against that
+    result.first["read_stream"].should == 1
+  end
+  
+  
+  it "should be able to access protected information via FQL.multiquery" do
+    result = @api.fql_multiquery(
+      :query1 => "select post_id from stream where source_id = me()", 
+      :query2 => "select fromid from comment where post_id in (select post_id from #query1)", 
+      :query3 => "select uid, name from user where uid in (select fromid from #query2)"
+    )
+    result.size.should == 3 
+    result.keys.should include("query1", "query2", "query3")
+  end
+
+end
+
+
+shared_examples_for "Koala RestAPI without an access token" do
+  # FQL_QUERY
+  describe "when making a FQL request" do
+    it "should be able to access public information via FQL" do
+      @result = @api.fql_query("select first_name from user where uid = 216743")
+      @result.size.should == 1
+      @result.first["first_name"].should == "Chris"
+    end
+    
+    it "should be able to access public information via FQL.multiquery" do
+      result = @api.fql_multiquery(
+        :query1 => 'select first_name from user where uid = 216743',
+        :query2 => 'select first_name from user where uid = 2905623'
+      )
+      result.size.should == 2
+      result["query1"].first['first_name'].should == 'Chris'
+      result["query2"].first['first_name'].should == 'Alex'
+    end
+
+    it "should not be able to access protected information via FQL" do
+      lambda { @api.fql_query("select read_stream from permissions where uid = 216743") }.should raise_error(Koala::Facebook::APIError)
+    end
+    
+    it "should not be able to access protected information via FQL.multiquery" do
+      lambda { 
+        @api.fql_multiquery(
+          :query1 => "select post_id from stream where source_id = me()", 
+          :query2 => "select fromid from comment where post_id in (select post_id from #query1)", 
+          :query3 => "select uid, name from user where uid in (select fromid from #query2)"
+        ) 
+      }.should raise_error(Koala::Facebook::APIError)
+    end
+  end
+end

data/spec/support/setup_mocks_or_live.rb

@@ -0,0 +1,51 @@
+# 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)
+    perms = api.fql_query("select read_stream, publish_stream, user_photos, user_videos, read_insights from permissions where uid = me()")[0]
+    perms.each_pair do |perm, value|
+      if value == (perm == "read_insights" ? 1 : 0) # live testing depends on insights calls failing 
+        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, and lack read_insights.  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

data/spec/support/uploadable_io_shared_examples.rb

@@ -0,0 +1,76 @@
+shared_examples_for "MIME::Types can't return results" do
+  {
+    "jpg" => "image/jpeg",
+    "jpeg" => "image/jpeg",
+    "png" => "image/png",
+    "gif" => "image/gif"
+  }.each_pair do |extension, mime_type|
+    it "should properly get content types for #{extension} using basic analysis" do
+      path = "filename.#{extension}"
+      if @koala_io_params[0].is_a?(File)
+        @koala_io_params[0].stub!(:path).and_return(path)
+      else
+        @koala_io_params[0] = path
+      end
+      Koala::UploadableIO.new(*@koala_io_params).content_type.should == mime_type
+    end
+
+    it "should get content types for #{extension} using basic analysis with file names with more than one dot" do
+      path = "file.name.#{extension}"
+      if @koala_io_params[0].is_a?(File)
+        @koala_io_params[0].stub!(:path).and_return(path)
+      else
+        @koala_io_params[0] = path
+      end
+      Koala::UploadableIO.new(*@koala_io_params).content_type.should == mime_type
+    end
+  end
+
+  describe "if the MIME type can't be determined" do
+    before :each do
+      path = "badfile.badextension"
+      if @koala_io_params[0].is_a?(File)
+        @koala_io_params[0].stub!(:path).and_return(path)
+      else
+        @koala_io_params[0] = path
+      end
+    end
+
+    it "should throw an exception if the MIME type can't be determined and the HTTP service requires content type" do
+      Koala.stub!(:multipart_requires_content_type?).and_return(true)
+      lambda { Koala::UploadableIO.new(*@koala_io_params) }.should raise_exception(Koala::KoalaError)
+    end
+
+    it "should just have @content_type == nil if the HTTP service doesn't require content type" do
+      Koala.stub!(:multipart_requires_content_type?).and_return(false)
+      Koala::UploadableIO.new(*@koala_io_params).content_type.should be_nil
+    end
+  end
+end
+
+shared_examples_for "determining a mime type" do
+  describe "if MIME::Types is available" do
+    it "should return an UploadIO with MIME::Types-determined type if the type exists" do
+      type_result = ["type"]
+      Koala::MIME::Types.stub(:type_for).and_return(type_result)
+      Koala::UploadableIO.new(*@koala_io_params).content_type.should == type_result.first
+    end
+  end
+
+  describe "if MIME::Types is unavailable" do
+    before :each do
+      # fake that MIME::Types doesn't exist
+      Koala::MIME::Types.stub(:type_for).and_raise(NameError)
+    end
+    it_should_behave_like "MIME::Types can't return results"
+  end
+
+  describe "if MIME::Types can't find the result" do
+    before :each do
+      # fake that MIME::Types doesn't exist
+      Koala::MIME::Types.stub(:type_for).and_return([])
+    end
+
+    it_should_behave_like "MIME::Types can't return results"
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: koala
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -14,69 +10,123 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 +02:00
+date: 2011-07-18 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
-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.
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.5"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: 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.
 email: alex@alexkoppel.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- readme.md
 - CHANGELOG
-- LICENSE
-- lib/koala.rb
-- lib/koala/graph_api.rb
-- lib/koala/http_services.rb
-- lib/koala/realtime_updates.rb
-- lib/koala/rest_api.rb
 files: 
+- .autotest
+- .gitignore
+- .travis.yml
 - CHANGELOG
+- Gemfile
 - 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
+- autotest/discover.rb
 - koala.gemspec
 - lib/koala.rb
+- lib/koala/batch_operation.rb
 - lib/koala/graph_api.rb
+- lib/koala/graph_batch_api.rb
+- lib/koala/graph_collection.rb
 - lib/koala/http_services.rb
+- lib/koala/http_services/net_http_service.rb
+- lib/koala/http_services/typhoeus_service.rb
+- lib/koala/oauth.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/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_with_access_token_tests.rb
-- spec/koala/graph_api/graph_collection_tests.rb
-- spec/koala/live_testing_data_helper.rb
-- spec/koala/net_http_service_tests.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_with_access_token_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
+- spec/cases/api_base_spec.rb
+- spec/cases/graph_and_rest_api_spec.rb
+- spec/cases/graph_api_batch_spec.rb
+- spec/cases/graph_api_spec.rb
+- spec/cases/http_services/http_service_spec.rb
+- spec/cases/http_services/net_http_service_spec.rb
+- spec/cases/http_services/typhoeus_service_spec.rb
+- spec/cases/koala_spec.rb
+- spec/cases/oauth_spec.rb
+- spec/cases/realtime_updates_spec.rb
+- spec/cases/rest_api_spec.rb
+- spec/cases/test_users_spec.rb
+- spec/cases/uploadable_io_spec.rb
+- spec/fixtures/beach.jpg
+- spec/fixtures/cat.m4v
+- spec/fixtures/facebook_data.yml
+- spec/fixtures/mock_facebook_responses.yml
+- spec/spec_helper.rb
+- spec/support/graph_api_shared_examples.rb
+- spec/support/json_testing_fix.rb
+- spec/support/live_testing_data_helper.rb
+- spec/support/mock_http_service.rb
+- spec/support/rest_api_shared_examples.rb
+- spec/support/setup_mocks_or_live.rb
+- spec/support/uploadable_io_shared_examples.rb
 has_rdoc: true
 homepage: http://github.com/arsduo/koala
 licenses: []
@@ -87,31 +137,53 @@ 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: -702788258280667645
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 2
       version: "1.2"
 requirements: []
 
-rubyforge_project: koala
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.6.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.
-test_files: []
-
+summary: A lightweight, flexible library for Facebook with support for the Graph API, the REST API, realtime updates, and OAuth authentication.
+test_files: 
+- spec/cases/api_base_spec.rb
+- spec/cases/graph_and_rest_api_spec.rb
+- spec/cases/graph_api_batch_spec.rb
+- spec/cases/graph_api_spec.rb
+- spec/cases/http_services/http_service_spec.rb
+- spec/cases/http_services/net_http_service_spec.rb
+- spec/cases/http_services/typhoeus_service_spec.rb
+- spec/cases/koala_spec.rb
+- spec/cases/oauth_spec.rb
+- spec/cases/realtime_updates_spec.rb
+- spec/cases/rest_api_spec.rb
+- spec/cases/test_users_spec.rb
+- spec/cases/uploadable_io_spec.rb
+- spec/fixtures/beach.jpg
+- spec/fixtures/cat.m4v
+- spec/fixtures/facebook_data.yml
+- spec/fixtures/mock_facebook_responses.yml
+- spec/spec_helper.rb
+- spec/support/graph_api_shared_examples.rb
+- spec/support/json_testing_fix.rb
+- spec/support/live_testing_data_helper.rb
+- spec/support/mock_http_service.rb
+- spec/support/rest_api_shared_examples.rb
+- spec/support/setup_mocks_or_live.rb
+- spec/support/uploadable_io_shared_examples.rb

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