koala 0.10.0 → 1.0.0.beta2.1

data/spec/koala/uploadable_io/uploadable_io_tests.rb

@@ -0,0 +1,246 @@
+# fake MIME::Types
+module Koala::MIME
+  module Types
+    def self.type_for(type)
+      # this should be faked out in tests
+      nil
+    end
+  end
+end
+
+class UploadableIOTests < Test::Unit::TestCase
+  include Koala
+  
+  VALID_PATH = File.join(File.dirname(__FILE__), "..", "assets", "beach.jpg")
+  
+  describe UploadableIO do
+    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
+          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
+          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 { UploadableIO.new(*@koala_io_params) }.should raise_exception(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)
+          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)
+          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    
+    
+    describe "the constructor" do      
+      describe "when given a file path" do
+        before(:each) do
+          @koala_io_params = [
+            File.open(VALID_PATH)
+          ]
+        end
+        
+        describe "and a content type" do
+          before :each do
+            @koala_io_params.concat([stub("image/jpg")])
+          end
+          
+          it "should return an UploadIO with the same file path" do
+            stub_path = @koala_io_params[0] = "/stub/path/to/file"              
+            UploadableIO.new(*@koala_io_params).io_or_path.should == stub_path
+          end
+        
+          it "should return an UploadIO with the same content type" do
+            stub_type = @koala_io_params[1] = stub('Content Type')
+            UploadableIO.new(*@koala_io_params).content_type.should == stub_type
+          end
+        end
+        
+        describe "and no content type" do
+          it_should_behave_like "determining a mime type"
+        end
+      end
+      
+      describe "when given a File object" do
+        before(:each) do
+          @koala_io_params = [
+            File.open(VALID_PATH)
+          ]
+        end
+        
+        describe "and a content type" do
+          before :each do
+            @koala_io_params.concat(["image/jpg"])
+          end
+          
+          it "should return an UploadIO with the same io" do
+            UploadableIO.new(*@koala_io_params).io_or_path.should == @koala_io_params[0]
+          end
+        
+          it "should return an UplaodIO with the same content_type" do
+            content_stub = @koala_io_params[1] = stub('Content Type')
+            UploadableIO.new(*@koala_io_params).content_type.should == content_stub
+          end
+        end
+        
+        describe "and no content type" do
+          it_should_behave_like "determining a mime type"
+        end
+      end
+      
+      describe "when given a Rails 3 ActionDispatch::Http::UploadedFile" do
+        before(:each) do
+          @tempfile = stub('Tempfile', :path => true)
+          @uploaded_file = stub('ActionDispatch::Http::UploadedFile', 
+            :content_type => true,
+            :tempfile => @tempfile
+          )
+
+          @uploaded_file.stub!(:respond_to?).with(:path).and_return(true)
+          @uploaded_file.stub!(:respond_to?).with(:content_type).and_return(true)
+          @uploaded_file.stub!(:respond_to?).with(:tempfile).and_return(@tempfile)
+          @tempfile.stub!(:respond_to?).with(:path).and_return(true)
+        end
+        
+        it "should get the content type via the content_type method" do
+          expected_content_type = stub('Content Type')
+          @uploaded_file.should_receive(:content_type).and_return(expected_content_type)
+          UploadableIO.new(@uploaded_file).content_type.should == expected_content_type
+        end
+        
+        it "should get the path from the tempfile associated with the UploadedFile" do
+          expected_path = stub('Tempfile')
+          @tempfile.should_receive(:path).and_return(expected_path)
+          UploadableIO.new(@uploaded_file).io_or_path.should == expected_path          
+        end
+      end
+      
+      describe "when given a Sinatra file parameter hash" do
+        before(:each) do
+          @file_hash = {
+            :type => "type",
+            :tempfile => "Tempfile"
+          }
+        end
+        
+        it "should get the content type from the :type key" do
+          expected_content_type = stub('Content Type')
+          @file_hash[:type] = expected_content_type
+          
+          uploadable = UploadableIO.new(@file_hash)
+          uploadable.content_type.should == expected_content_type          
+        end
+        
+        it "should get the io_or_path from the :tempfile key" do
+          expected_file = stub('File')
+          @file_hash[:tempfile] = expected_file
+                    
+          uploadable = UploadableIO.new(@file_hash)
+          uploadable.io_or_path.should == expected_file
+        end
+      end
+
+      describe "for files with with recognizable MIME types" do
+        # what that means is tested below
+        it "should accept a file object alone" do
+          params = [
+            VALID_PATH
+          ]
+          lambda { UploadableIO.new(*params) }.should_not raise_exception(KoalaError)
+        end
+        
+        it "should accept a file path alone" do
+          params = [
+            VALID_PATH
+          ]
+          lambda { UploadableIO.new(*params) }.should_not raise_exception(KoalaError)
+        end
+      end
+    end
+          
+    describe "getting an UploadableIO" do
+      before(:each) do
+        @upload_io = stub("UploadIO")
+        UploadIO.stub!(:new).with(anything, anything, anything).and_return(@upload_io)
+      end
+      
+      it "should call the constructor with the content type, file name, and a dummy file name" do
+        UploadIO.should_receive(:new).with(VALID_PATH, "content/type", anything).and_return(@upload_io)
+        UploadableIO.new(VALID_PATH, "content/type").to_upload_io.should == @upload_io        
+      end
+    end
+    
+    describe "getting a file" do
+      it "should return the File if initialized with a file" do
+        f = File.new(VALID_PATH)
+        UploadableIO.new(f).to_file.should == f
+      end
+      
+      it "should open up and return a file corresponding to the path if io_or_path is a path" do
+        path = VALID_PATH
+        result = stub("File")
+        File.should_receive(:open).with(path).and_return(result)
+        UploadableIO.new(path).to_file.should == result
+      end
+    end
+  end  # describe UploadableIO
+end # class

data/spec/koala_spec_helper.rb

@@ -5,15 +5,15 @@ if defined?(RUBY_VERSION) && RUBY_VERSION =~ /1\.9/
   Rspec.configure do |c|
     c.mock_with :rspec
   end
-  
+
 else
   # Ruby 1.8.x
   require 'test/unit'
   require 'rubygems'
-
-  require 'spec/test/unit'
 end
 
+require 'yaml'
+
 # load the libraries
 require 'koala'
 
@@ -23,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'
 
@@ -39,10 +41,34 @@ require 'koala/oauth/oauth_tests'
 # Subscriptions tests
 require 'koala/realtime_updates/realtime_updates_tests'
 
-# Services tests
-require 'koala/net_http_service_tests'
-
 # Test users tests
 require 'koala/test_users/test_users_tests'
 
+# KoalaIO tests
+require 'koala/uploadable_io/uploadable_io_tests'
 
+# Services tests
+require 'koala/http_services/http_service_tests'
+require 'koala/http_services/net_http_service_tests'
+begin
+  require 'koala/http_services/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"]
@@ -16,4 +14,6 @@ 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
+end
+
+KoalaTest.validate_user_info $testing_data["oauth_token"]

data/spec/mock_facebook_responses.yml

@@ -49,8 +49,12 @@ graph_api:
     
   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.."}'
-      
+      with_token: '{"id": "777777777", "access_token":"<%= ACCESS_TOKEN %>", "login_url":"https://www.facebook.com/platform/test_account.."}'
+  
+  test_user_befriended: &test_user_befriended
+    post:
+      with_token: 'true'
+  
 # -- Stubbed Responses --
   root:
     ids=contextoptional,naitik: 
@@ -79,10 +83,18 @@ graph_api:
     message=Hello, world, from the test suite delete method!: 
       post: 
         with_token: '{"id": "FEED_ITEM_DELETE"}'
-    link=http://www.contextoptional.com/&message=Hello, world, from the test suite again!&name=Context Optional:
+    link=http://oauth.twoalex.com/&message=Hello, world, from the test suite again!&name=OAuth Playground:
       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:
@@ -226,7 +238,7 @@ graph_api:
     no_args: 
       <<: *item_deleted
       get:
-        with_token: '{"link":"http://www.contextoptional.com/", "name": "Context Optional"}'
+        with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground"}'
   
   /FEED_ITEM_CATS:
     no_args:
@@ -237,12 +249,23 @@ 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!\"}"
+  /MOCK_PHOTO:
+    no_args:
+      <<: *item_deleted
+      get:
+        with_token: "{\"name\": \"This is the test message\"}"
         
 # -- Mock Test User Responses --
   /<%= APP_ID %>/accounts/test-users:
@@ -252,18 +275,24 @@ graph_api:
       <<: *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.."}'
+        with_token: '{"id": "999999999", "access_token":"<%= ACCESS_TOKEN %>", "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.."}'
+        with_token: '{"id": "888888888", "access_token":"<%= ACCESS_TOKEN %>", "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.."}]}'
+        with_token: '{"data":[{"id": "999999999", "access_token":"<%= ACCESS_TOKEN %>", "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
 
+  /999999999/friends/888888888:
+    no_args:
+      post:
+        with_token: 'true'
+
+
   /9999999991:
     no_args:
       delete:
@@ -273,17 +302,11 @@ graph_api:
     no_args:
       <<: *item_deleted   
 
-  /777777777:
+  /888888888/friends/999999999:
     no_args:
-      <<: *item_deleted
+      <<: *test_user_befriended
 
-  /999999999/friends/888888888:
-    no_args:
-      get:
-        with_token: 'true'
-      
-  /888888888/friends/999999999:
+
+  /777777777:
     no_args:
-      get:
-        with_token: 'true'
-  
+      <<: *item_deleted

data/spec/mock_http_service.rb

@@ -33,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'
@@ -43,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]
@@ -62,8 +64,7 @@ module Koala
             # 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)  
-            
+            # (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}&"
@@ -76,6 +77,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?(Koala::UploadableIO)
+              arr.join('=')
+            end.join('&')
+          end
+        end
+        
       end # class_eval
     end # included
   end

metadata

@@ -1,12 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: koala
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 124392909
+  prerelease: 6
   segments: 
+  - 1
   - 0
-  - 10
   - 0
-  version: 0.10.0
+  - beta
+  - 2
+  - 1
+  version: 1.0.0.beta2.1
 platform: ruby
 authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -14,22 +18,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-15 00:00:00 +01:00
+date: 2011-04-06 00:00:00 +02:00
 default_executable: 
 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: []
@@ -45,6 +66,7 @@ extra_rdoc_files:
 - lib/koala/realtime_updates.rb
 - lib/koala/rest_api.rb
 - lib/koala/test_users.rb
+- lib/koala/uploadable_io.rb
 files: 
 - CHANGELOG
 - LICENSE
@@ -58,21 +80,28 @@ files:
 - 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/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_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
@@ -88,21 +117,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
@@ -110,7 +141,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.