koala 1.0.0.beta2.1 → 1.0.0

data/spec/{mock_http_service.rb → support/mock_http_service.rb}

@@ -1,95 +1,95 @@
-require 'erb'
-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 = '*'
-    OAUTH_CODE = 'OAUTHCODE'
-    
-    # Loads testing data
-    TEST_DATA = YAML.load_file(File.join(File.dirname(__FILE__), 'facebook_data.yml'))
-    TEST_DATA.merge!('oauth_token' => Koala::MockHTTPService::ACCESS_TOKEN)
-    TEST_DATA['oauth_test_data'].merge!('code' => Koala::MockHTTPService::OAUTH_CODE)
-    
-    # Useful in mock_facebook_responses.yml
-    OAUTH_DATA = TEST_DATA['oauth_test_data']
-    OAUTH_DATA.merge!({
-      'app_access_token' => Koala::MockHTTPService::ACCESS_TOKEN,
-      'session_key' => "session_key",
-      'multiple_session_keys' => ["session_key", "session_key_2"]
-    })
-    APP_ID = OAUTH_DATA['app_id']
-    SECRET = OAUTH_DATA['secret']
-    SUBSCRIPTION_DATA = TEST_DATA["subscription_test_data"]
-
-    # Loads the mock response data via ERB to substitue values for TEST_DATA (see oauth/access_token)
-    mock_response_file_path = File.join(File.dirname(__FILE__), 'mock_facebook_responses.yml') 
-    RESPONSES = YAML.load(ERB.new(IO.read(mock_response_file_path)).result(binding))         
-
-    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'
-          server = options[:rest_api] ? 'rest_api' : 'graph_api'
-          with_token = args.delete('access_token') == ACCESS_TOKEN ? 'with_token' : 'no_token'
-          
-          # Assume format is always JSON
-          args.delete('format')
-          
-          # Create a hash key for the arguments
-          args = create_params_key(args)
-          
-          begin
-            response = RESPONSES[server][path][args][verb][with_token]
-            
-            # Raises an error of with_token/no_token key is missing
-            raise NoMethodError unless response
-            
-            # create response class object
-            response_object = if response.is_a? String
-                Koala::Response.new(200, response, {})
-              else
-                Koala::Response.new(response["code"] || 200, response["body"] || "", response["headers"] || {})
-              end
-              
-          rescue NoMethodError
-            # Raises an error message with the place in the data YML
-            # to place a mock as well as a URL to request from
-            # Facebook's servers for the actual data
-            # (Don't forget to replace ACCESS_TOKEN with a real access token)              
-            data_trace = [server, path, args, verb, with_token] * ': '
-            
-            args = args == 'no_args' ? '' : "#{args}&"
-            args += 'format=json'
-            args += "&access_token=#{ACCESS_TOKEN}" if with_token 
-            
-            raise "Missing a mock response for #{data_trace}\nAPI PATH: #{[path, args].join('?')}"
-          end
-          
-          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?(Koala::UploadableIO)
-              arr.join('=')
-            end.join('&')
-          end
-        end
-        
-      end # class_eval
-    end # included
-  end
+require 'erb'
+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 = '*'
+    OAUTH_CODE = 'OAUTHCODE'
+
+    # Loads testing data
+    TEST_DATA = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'fixtures', 'facebook_data.yml'))
+    TEST_DATA.merge!('oauth_token' => Koala::MockHTTPService::ACCESS_TOKEN)
+    TEST_DATA['oauth_test_data'].merge!('code' => Koala::MockHTTPService::OAUTH_CODE)
+
+    # Useful in mock_facebook_responses.yml
+    OAUTH_DATA = TEST_DATA['oauth_test_data']
+    OAUTH_DATA.merge!({
+      'app_access_token' => Koala::MockHTTPService::ACCESS_TOKEN,
+      'session_key' => "session_key",
+      'multiple_session_keys' => ["session_key", "session_key_2"]
+    })
+    APP_ID = OAUTH_DATA['app_id']
+    SECRET = OAUTH_DATA['secret']
+    SUBSCRIPTION_DATA = TEST_DATA["subscription_test_data"]
+
+    # Loads the mock response data via ERB to substitue values for TEST_DATA (see oauth/access_token)
+    mock_response_file_path = File.join(File.dirname(__FILE__), '..', 'fixtures', 'mock_facebook_responses.yml')
+    RESPONSES = YAML.load(ERB.new(IO.read(mock_response_file_path)).result(binding))
+
+    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'
+          server = options[:rest_api] ? 'rest_api' : 'graph_api'
+          with_token = args.delete('access_token') == ACCESS_TOKEN ? 'with_token' : 'no_token'
+
+          # Assume format is always JSON
+          args.delete('format')
+
+          # Create a hash key for the arguments
+          args = create_params_key(args)
+
+          begin
+            response = RESPONSES[server][path][args][verb][with_token]
+
+            # Raises an error of with_token/no_token key is missing
+            raise NoMethodError unless response
+
+            # create response class object
+            response_object = if response.is_a? String
+                Koala::Response.new(200, response, {})
+              else
+                Koala::Response.new(response["code"] || 200, response["body"] || "", response["headers"] || {})
+              end
+
+          rescue NoMethodError
+            # Raises an error message with the place in the data YML
+            # to place a mock as well as a URL to request from
+            # Facebook's servers for the actual data
+            # (Don't forget to replace ACCESS_TOKEN with a real access token)
+            data_trace = [server, path, args, verb, with_token] * ': '
+
+            args = args == 'no_args' ? '' : "#{args}&"
+            args += 'format=json'
+            args += "&access_token=#{ACCESS_TOKEN}" if with_token
+
+            raise "Missing a mock response for #{data_trace}\nAPI PATH: #{[path, args].join('?')}"
+          end
+
+          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?(Koala::UploadableIO)
+              arr.join('=')
+            end.join('&')
+          end
+        end
+
+      end # class_eval
+    end # included
+  end
 end

data/spec/{koala/rest_api/rest_api_tests.rb → support/rest_api_shared_examples.rb}

@@ -115,4 +115,47 @@ shared_examples_for "Koala RestAPI" do
       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 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 assume that you have read_stream permissions, so we can test against that
+    # (should we keep this?)
+    result.first["read_stream"].should == 1
+  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 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
+  end
 end

data/spec/support/setup_mocks_or_live.rb

@@ -0,0 +1,52 @@
+# 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

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,16 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: koala
 version: !ruby/object:Gem::Version 
-  hash: 124392909
-  prerelease: 6
+  hash: 23
+  prerelease: 
   segments: 
   - 1
   - 0
   - 0
-  - beta
-  - 2
-  - 1
-  version: 1.0.0.beta2.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -18,16 +15,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 +02:00
-default_executable: 
+date: 2011-05-01 00:00:00 Z
 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: 
@@ -35,14 +30,14 @@ dependencies:
         - 0
         version: "1.0"
   type: :runtime
+  name: json
   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: 
@@ -50,29 +45,72 @@ dependencies:
         - 0
         version: "1.0"
   type: :runtime
+  name: multipart-post
   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.
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  name: rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  name: rake
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :development
+  name: typhoeus
+  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
-- lib/koala/test_users.rb
-- lib/koala/uploadable_io.rb
 files: 
+- .gitignore
 - CHANGELOG
+- Gemfile
 - LICENSE
 - Manifest
 - Rakefile
-- init.rb
 - koala.gemspec
 - lib/koala.rb
 - lib/koala/graph_api.rb
@@ -82,32 +120,27 @@ files:
 - 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
-has_rdoc: true
+- spec/cases/api_base_spec.rb
+- spec/cases/graph_and_rest_api_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/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/facebook_data.yml
+- spec/fixtures/mock_facebook_responses.yml
+- spec/spec_helper.rb
+- spec/support/graph_api_shared_examples.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
 homepage: http://github.com/arsduo/koala
 licenses: []
 
@@ -140,10 +173,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "1.2"
 requirements: []
 
-rubyforge_project: koala
-rubygems_version: 1.4.2
+rubyforge_project: 
+rubygems_version: 1.7.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_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/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/facebook_data.yml
+- spec/fixtures/mock_facebook_responses.yml
+- spec/spec_helper.rb
+- spec/support/graph_api_shared_examples.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/init.rb

@@ -1,2 +0,0 @@
-# init.rb
-require 'koala'