koala 1.6.0 → 1.7.0rc1

data/spec/cases/test_users_spec.rb

@@ -20,7 +20,7 @@ describe "Koala::Facebook::TestUsers" do
     # Facebook only allows us 500 test users per app, so we have to clean up
     # This would be a good place to clean up and accumulate all of them for
     # later deletion.
-    unless KoalaTest.mock_interface?
+    unless KoalaTest.mock_interface? || @stubbed
       ((@network || []) + [@user1, @user2]).each do |u|
         puts "Unable to delete test user #{u.inspect}" if u && !(@test_users.delete(u) rescue false)
       end
@@ -149,6 +149,7 @@ describe "Koala::Facebook::TestUsers" do
       end
 
       it "accepts http options" do
+        @stubbed = true
         options = {:some_http_option => true}
         @test_users.api.should_receive(:graph_call).with(anything, anything, anything, options)
         @test_users.list(options)
@@ -178,6 +179,7 @@ describe "Koala::Facebook::TestUsers" do
       it "lets you specify http options that get passed through to the graph call" do
         options = {:some_http_option => true}
         # technically this goes through delete_object, but this makes it less brittle
+        @stubbed = true
         @test_users.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
         @test_users.delete("user", options)
       end
@@ -229,6 +231,7 @@ describe "Koala::Facebook::TestUsers" do
 
       it "accepts an options hash" do
         options = {:some_http_option => true}
+        @stubbed = true
         @test_users2.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
         @test_users2.update("foo", @updates, options)
       end
@@ -269,6 +272,7 @@ describe "Koala::Facebook::TestUsers" do
       it "accepts http options passed to both calls" do
         options = {:some_http_option => true}
         # should come twice, once for each user
+        @stubbed = true
         Koala.http_service.should_receive(:make_request).with(anything, anything, anything, options).twice.and_return(Koala::HTTPService::Response.new(200, "{}", {}))
         @test_users.befriend(@user1, @user2, options)
       end

data/spec/fixtures/mock_facebook_responses.yml

@@ -126,9 +126,6 @@ graph_api:
       post:
         with_token: '[{"code": 200, "body":"{\"id\": \"MOCK_PHOTO\"}"}, {"code": 200, "body":"{\"id\": \"MOCK_PHOTO\"}"}]'
 
-
-
-
   /me:
     no_args:
       get:
@@ -166,9 +163,9 @@ graph_api:
     link=http://oauth.twoalex.com/&message=Hello, world, from the test suite again!&name=OAuth Playground:
       post:
         with_token: '{"id": "FEED_ITEM_CONTEXT"}'
-    link=http://oauth.twoalex.com/&message=body&name=It's a big question&picture=http://oauth.twoalex.com//images/logo.png&properties=<%= {"name"=>"Link1'", "text"=>"Left", "href"=>"http://oauth.twoalex.com/"}.to_s %>=<%= {"name"=>"other", "text"=>"Straight ahead"}.to_s %>&type=link:
+    link=http://oauth.twoalex.com/&message=body&name=It's a big question&picture=http://oauth.twoalex.com//images/logo.png&properties=<%= MultiJson.encode({"Link1"=>{"text"=>"Left", "href"=>"http://oauth.twoalex.com/"}, "other" => {"text"=>"Straight ahead", "href"=>"http://oauth.twoalex.com/?"}}) %>&type=link:
       post:
-        with_token: '{"id": "FEED_ITEM_CONTEXT"}'
+        with_token: '{"id": "FEED_ITEM_DICTIONARY"}'
 
   /me/photos:
     source=[FILE]:
@@ -308,6 +305,11 @@ graph_api:
       post:
         with_token: "true"
 
+  /debug_token:
+    input_token=<%= APP_ACCESS_TOKEN %>:
+      get:
+        with_token: '{ "data": { "app_id": <%= APP_ID %>, "application": "Social Cafe", "expires_at": 1352419328, "is_valid": true, "issued_at": 1347235328, "metadata": { "sso": "iphone-safari" }, "scopes": [ "email", "publish_actions" ], "user_id": 1207059 } }'
+
   # -- OAuth responses --
   /oauth/access_token:
     client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&code=<%= OAUTH_CODE %>&redirect_uri=<%= OAUTH_DATA["callback_url"] %>:
@@ -316,7 +318,7 @@ graph_api:
     client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&code=foo&redirect_uri=<%= OAUTH_DATA["callback_url"] %>:
       get:
         <<: *oauth_error
-    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&type=client_cred:
+    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&grant_type=client_credentials:
       post:
         no_token: access_token=<%= APP_ACCESS_TOKEN %>
     client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&fb_exchange_token=<%= ACCESS_TOKEN %>&grant_type=fb_exchange_token:
@@ -407,6 +409,12 @@ graph_api:
       get:
         with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground"}'
 
+  /FEED_ITEM_DICTIONARY:
+    no_args:
+      <<: *item_deleted
+      get:
+        with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground", "properties": {}}'
+
   /FEED_ITEM_CATS:
     no_args:
       <<: *item_deleted

data/spec/spec_helper.rb

@@ -1,46 +1,30 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'Although not required, bundler is recommended for running the tests.'
+if RUBY_VERSION == '1.9.2' && RUBY_PATCHLEVEL < 290 && RUBY_ENGINE != "macruby"
+  # In Ruby 1.9.2 versions before patchlevel 290, the default Psych
+  # parser has an issue with YAML merge keys, which
+  # fixtures/mock_facebook_responses.yml relies heavily on.
+  #
+  # Anyone using an earlier version will see missing mock response
+  # errors when running the test suite similar to this:
+  #
+  # RuntimeError:
+  #   Missing a mock response for graph_api: /me/videos: source=[FILE]: post: with_token
+  #   API PATH: /me/videos?source=[FILE]&format=json&access_token=*
+  #
+  # For now, it seems the best fix is to just downgrade to the old syck YAML parser
+  # for these troubled versions.
+  #
+  # See https://github.com/tenderlove/psych/issues/8 for more details
+  YAML::ENGINE.yamler = 'syck'
 end
 
-# In Ruby 1.9.2 versions before patchlevel 290, the default Psych
-# parser has an issue with YAML merge keys, which
-# fixtures/mock_facebook_responses.yml relies heavily on.
-#
-# Anyone using an earlier version will see missing mock response
-# errors when running the test suite similar to this:
-#
-# RuntimeError:
-#   Missing a mock response for graph_api: /me/videos: source=[FILE]: post: with_token
-#   API PATH: /me/videos?source=[FILE]&format=json&access_token=*
-#
-# For now, it seems the best fix is to just downgrade to the old syck YAML parser
-# for these troubled versions.
-#
-# See https://github.com/tenderlove/psych/issues/8 for more details
-YAML::ENGINE.yamler = 'syck' if RUBY_VERSION == '1.9.2' && RUBY_PATCHLEVEL < 290
-
-# load custom RSpec matchers
-require 'support/custom_matchers'
-
 # load the library
 require 'koala'
 
-# ensure consistent to_json behavior
-# this must be required first so mock_http_service loads the YAML as expected
-require 'support/ordered_hash'
-require 'support/json_testing_fix'
+# Support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 # set up our testing environment
-require 'support/mock_http_service'
-require 'support/koala_test'
 # load testing data and (if needed) create test users or validate real users
 KoalaTest.setup_test_environment!
 
-# load supporting files for our tests
-require 'support/rest_api_shared_examples'
-require 'support/graph_api_shared_examples'
-require 'support/uploadable_io_shared_examples'
-
 BEACH_BALL_PATH = File.join(File.dirname(__FILE__), "fixtures", "beach.jpg")

data/spec/support/graph_api_shared_examples.rb

@@ -85,12 +85,19 @@ shared_examples_for "Koala GraphAPI" do
     results.should have(2).items
   end
 
-  it "can access a user's picture" do
-    @api.get_picture(KoalaTest.user2).should =~ /http[s]*\:\/\//
-  end
+  describe "#get_picture" do
+    it "can access a user's picture" do
+      @api.get_picture(KoalaTest.user2).should =~ /http[s]*\:\/\//
+    end
+
+    it "can access a user's picture, given a picture type"  do
+      @api.get_picture(KoalaTest.user2, {:type => 'large'}).should =~ /^http[s]*\:\/\//
+    end
 
-  it "can access a user's picture, given a picture type"  do
-    @api.get_picture(KoalaTest.user2, {:type => 'large'}).should =~ /^http[s]*\:\/\//
+    it "works even if Facebook returns nil" do
+      @api.stub(:graph_call).and_return(nil)
+      @api.get_picture(KoalaTest.user2, {:type => 'large'}).should be_nil
+    end
   end
 
   it "can access connections from public Pages" do
@@ -251,22 +258,25 @@ shared_examples_for "Koala GraphAPI with an access token" do
 
   it "can post a message whose attachment has a properties dictionary" do
     url = KoalaTest.oauth_test_data["callback_url"]
-    options = {
-    "picture" => "#{KoalaTest.oauth_test_data["callback_url"]}/images/logo.png",
-    "name" => "It's a big question",
-    "type" => "link",
-    "link" => KoalaTest.oauth_test_data["callback_url"],
-    "properties" => [
-        {"name" => "Link1'", "text" => "Left", "href" => url},
-        {"name" => "other", "text" => "Straight ahead"}
-      ]
+    args = {
+      "picture" => "#{KoalaTest.oauth_test_data["callback_url"]}/images/logo.png",
+      "name" => "It's a big question",
+      "type" => "link",
+      "link" => KoalaTest.oauth_test_data["callback_url"],
+      "properties" => {
+        "Link1" => {"text" => "Left", "href" => url},
+        "other" => {"text" => "Straight ahead", "href" => url + "?"}
+      }
     }
 
-    result = @api.put_wall_post("body", options)
+    result = @api.put_wall_post("body", args)
     @temporary_object_id = result["id"]
     @temporary_object_id.should_not be_nil
-  end
 
+    # ensure the properties dictionary is there
+    api_data = @api.get_object(@temporary_object_id)
+    api_data["properties"].should_not be_nil
+  end
 
   describe "#put_picture" do
     it "can post photos to the user's wall with an open file object" do
@@ -343,7 +353,6 @@ shared_examples_for "Koala GraphAPI with an access token" do
       @temporary_object_id.should_not be_nil
     end
 
-
     it "can post videos to the user's wall without an open file object" do
       result = @api.put_video(@cat_movie, @content_type)
       @temporary_object_id = result["id"]
@@ -412,6 +421,14 @@ shared_examples_for "Koala GraphAPI with an access token" do
     end
   end
 
+  it "can get information about an access token" do
+    result = @api.debug_token(KoalaTest.app_access_token)
+    result.should be_kind_of(Hash)
+    result["data"].should be_kind_of(Hash)
+    result["data"]["app_id"].to_s.should == KoalaTest.app_id.to_s
+    result["data"]["application"].should_not be_nil
+  end
+
   describe "#set_app_restrictions" do
     before :all do
       oauth = Koala::Facebook::OAuth.new(KoalaTest.app_id, KoalaTest.secret)

data/spec/support/koala_test.rb

@@ -32,6 +32,7 @@ module KoalaTest
       adapter = ENV['ADAPTER'] || "typhoeus" # use Typhoeus by default if available
       begin
         require adapter
+        require 'typhoeus/adapters/faraday' if adapter.to_s == "typhoeus"
         Faraday.default_adapter = adapter.to_sym
       rescue LoadError
         puts "Unable to load adapter #{adapter}, using Net::HTTP."
@@ -58,6 +59,13 @@ module KoalaTest
       end
 
       config.after :each do
+        # Clean up Koala config
+        Koala.configure do |config|
+          Koala::HTTPService::DEFAULT_SERVERS.each_pair do |k, v|
+            config.send("#{k}=", v)
+          end
+        end
+
         # if we're working with a real user, clean up any objects posted to Facebook
         # no need to do so for test users, since they get deleted at the end
         if @temporary_object_id && KoalaTest.real_user?
@@ -71,6 +79,7 @@ module KoalaTest
           # if we errored out or Facebook returned false, track that
           puts "Unable to delete #{@temporary_object_id}: #{result} (probably a photo or video, which can't be deleted through the API)" unless result
         end
+
       end
     end
   end
@@ -80,7 +89,7 @@ module KoalaTest
     self.oauth_test_data = data["oauth_test_data"]
     self.subscription_test_data = data["subscription_test_data"]
     self.oauth_token = data["oauth_token"]
-    self.app_id = data["oauth_test_data"]["app_id"]
+    self.app_id = data["oauth_test_data"]["app_id"].to_s
     self.app_access_token = data["oauth_test_data"]["app_access_token"]
     self.secret = data["oauth_test_data"]["secret"]
     self.code = data["oauth_test_data"]["code"]

data/spec/support/mock_http_service.rb

@@ -36,41 +36,22 @@ module Koala
     RESPONSES = YAML.load(ERB.new(IO.read(mock_response_file_path)).result(binding))
 
     def self.make_request(path, args, verb, options = {})
-      path = 'root' if path == '' || path == '/'
-      verb ||= 'get'
-      server = options[:rest_api] ? 'rest_api' : 'graph_api'
-      token = args.delete('access_token')
-      with_token = (token == ACCESS_TOKEN || token == APP_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
-
+      if response = match_response(path, args, verb, options)
         # create response class object
         response_object = if response.is_a? String
-            Koala::HTTPService::Response.new(200, response, {})
-          else
-            Koala::HTTPService::Response.new(response["code"] || 200, response["body"] || "", response["headers"] || {})
-          end
-
-      rescue NoMethodError
+          Koala::HTTPService::Response.new(200, response, {})
+        else
+          Koala::HTTPService::Response.new(response["code"] || 200, response["body"] || "", response["headers"] || {})
+        end
+      else
         # 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] * ': '
+        data_trace = [path, args, verb, options] * ': '
 
         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
@@ -85,15 +66,78 @@ module Koala
 
     protected
 
-    def self.create_params_key(params_hash)
-      if params_hash.empty?
-        'no_args'
+    # For a given query, see if our mock responses YAML has a resopnse for it.
+    def self.match_response(path, args, verb, options = {})
+      server = options[:rest_api] ? 'rest_api' : 'graph_api'
+      path = 'root' if path == '' || path == '/'
+      verb = (verb || 'get').to_s
+      token = args.delete('access_token')
+      with_token = (token == ACCESS_TOKEN || token == APP_ACCESS_TOKEN) ? 'with_token' : 'no_token'
+
+      if endpoint = RESPONSES[server][path]
+        # see if we have a match for the arguments
+        if arg_match = endpoint.find {|query, v| decode_query(query) == massage_args(args)}
+          # we have a match for the server/path/arguments
+          # so if it's the right verb and authentication, we're good
+          # arg_match will be [query, hash_response]
+          arg_match.last[verb][with_token]
+        end
+      end
+    end
+
+    # Since we're comparing the arguments with data in a yaml file, we need to
+    # massage them slightly to get to the format we expect.
+    def self.massage_args(arguments)
+      args = arguments.inject({}) do |hash, (k, v)|
+        # ensure our args are all stringified
+        value = if v.is_a?(String)
+          should_json_decode?(v) ? MultiJson.load(v) : v
+        elsif v.is_a?(Koala::UploadableIO)
+          # obviously there are no files in the yaml
+          "[FILE]"
+        else
+          v
+        end
+        # make sure all keys are strings
+        hash.merge(k.to_s => value)
+      end
+
+      # Assume format is always JSON
+      args.delete('format')
+
+      # if there are no args, return the special keyword no_args
+      args.empty? ? "no_args" : args
+    end
+
+    # Facebook sometimes requires us to encode JSON values in an HTTP query
+    # param. This complicates test matches, since we get into JSON-encoding
+    # issues (what order keys are written into).  To avoid string comparisons
+    # and the hacks required to make it work, we decode the query into a
+    # Ruby object.
+    def self.decode_query(string)
+      if string == "no_args"
+        string
       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('&')
+        # we can't use Faraday's decode_query because that CGI-unencodes, which
+        # will remove +'s in restriction strings
+        string.split("&").reduce({}) do |hash, component|
+          k, v = component.split("=", 2) # we only care about the first =
+          value = should_json_decode?(v) ? MultiJson.decode(v) : v.to_s rescue v.to_s
+          # some special-casing, unfortunate but acceptable in this testing
+          # environment
+          value = nil if value.empty?
+          value = true if value == "true"
+          value = false if value == "false"
+          hash.merge(k => value)
+        end
       end
     end
+
+    # We want to decode JSON because it may not be encoded in the same order
+    # all the time -- different Rubies may create a strings with equivalent
+    # content but different order.  We want to compare the objects.
+    def self.should_json_decode?(v)
+      v.match(/^[\[\{]/)
+    end
   end
 end

metadata

@@ -1,96 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 1.6.0
-  prerelease: 
+  version: 1.7.0rc1
+  prerelease: 5
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 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
@@ -157,7 +157,6 @@ files:
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb
 - spec/support/graph_api_shared_examples.rb
-- spec/support/json_testing_fix.rb
 - spec/support/koala_test.rb
 - spec/support/mock_http_service.rb
 - spec/support/ordered_hash.rb
@@ -181,19 +180,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4609092032250353184
+      hash: 3438610920641769302
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 4609092032250353184
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A lightweight, flexible library for Facebook with support for the Graph API,
@@ -221,7 +217,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb
 - spec/support/graph_api_shared_examples.rb
-- spec/support/json_testing_fix.rb
 - spec/support/koala_test.rb
 - spec/support/mock_http_service.rb
 - spec/support/ordered_hash.rb