koala 2.2.0rc2 → 2.2.0rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1e7b90f3b13d2c6f60d4c8a9e34204de7ab9ab3
-  data.tar.gz: c32873fb598b147a635937b11185ee50c1447655
+  metadata.gz: 9d723adaf8f3575e75b06fbb1b71d1736f3dafd1
+  data.tar.gz: ce7831b6eb0075a69fc90ffae8ac9a2a1fb18e2b
 SHA512:
-  metadata.gz: b1bf5427055f2839d424134140869c1b37d6bc79dc9a32f4ea3be347a5fab277d35318a14cc6f6940ed13dbe2ca3084e0dd55f1c6844110bc776fc1e1ec7ab69
-  data.tar.gz: e8c54ab5045c917872ecab6290157a6a89abd4cfdaa273d84d35293a8d25ae4f445696550365a0c69926b3f00774b37f759f6414102cbe3d10379aeaec5d5142
+  metadata.gz: 7fc6c7a281d7ab3381157254b93daa41c3514354da7a886cf4cc60f40b27f0bd360f55120a724b9a139d855303dac36a985db6de0ab374f8048454973bc02159
+  data.tar.gz: cee4ec7905570dbe9194d49a6fe0a5748ebb5111252281ca70db17c247a26b31333de4a07e9dffaf09b17061e37c2cfba8ed6d09f40584a316ba1687424bd7a3

data/changelog.md

@@ -3,6 +3,7 @@ v2.2.0
 
 Updated features:
 
+* Restore API#search, since Facebook still supports that for certain usecases (thanks, vhoof!)
 * You can now specify format: :json in http_options to make Content-Type application/json requests (thanks, adparlor!)
 * Koala now supports uploading videos by URL (thanks, filipegiusti!)
 * GraphCollections now offer direct access to the collection summary data via #summary (thanks, vhoof!)

data/lib/koala/api/graph_api.rb

@@ -312,6 +312,20 @@ module Koala
         graph_call("#{id}/likes", {}, "delete", options, &block)
       end
 
+      # Search for a given query among visible Facebook objects.
+      # See {http://developers.facebook.com/docs/reference/api/#searching Facebook documentation} for more information.
+      #
+      # @param search_terms the query to search for
+      # @param args additional arguments, such as type, fields, etc.
+      # @param options (see #get_object)
+      # @param block (see Koala::Facebook::API#api)
+      #
+      # @return [Koala::Facebook::API::GraphCollection] an array of search results
+      def search(search_terms, args = {}, options = {}, &block)
+        args.merge!({:q => search_terms}) unless search_terms.nil?
+        graph_call("search", args, "get", options, &block)
+      end
+
       # Convenience Methods
       # In general, we're trying to avoid adding convenience methods to Koala
       # except to support cases where the Facebook API requires non-standard input

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "2.2.0rc2"
+  VERSION = "2.2.0rc3"
 end

data/readme.md

@@ -69,7 +69,7 @@ Koala.config.api_version = "v2.0"
 
 The response of most requests is the JSON data returned from the Facebook servers as a Hash.
 
-When retrieving data that returns an array of results (for example, when calling `API#get_connections`)
+When retrieving data that returns an array of results (for example, when calling `API#get_connections` or `API#search`)
 a GraphCollection object will be returned, which makes it easy to page through the results:
 
 ```ruby

data/spec/fixtures/mock_facebook_responses.yml

@@ -271,6 +271,16 @@ graph_api:
         code: 500
         body: '{"error": {"type": "Exception","message": "No node specified"}}'
 
+  /search:
+    q=facebook:
+      get:
+        with_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
+        no_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
+    "limit=25&q=facebook&until=<%= TEST_DATA['search_time'] %>":
+      get:
+        with_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
+        no_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
+
   /fql:
     q=select uid, first_name from user where uid = 2901279:
       get:

data/spec/support/graph_api_shared_examples.rb

@@ -51,6 +51,12 @@ shared_examples_for "Koala GraphAPI" do
     end
   end
 
+  # SEARCH
+  it "can search" do
+    result = @api.search("facebook")
+    expect(result.length).to be_an(Integer)
+  end
+
   # DATA
   # access public info
 
@@ -117,6 +123,12 @@ shared_examples_for "Koala GraphAPI" do
     expect(result["http://developers.facebook.com/blog/post/490"] && result["http://developers.facebook.com/blog/post/472"]).to be_truthy
   end
 
+  # SEARCH
+  it "can search" do
+    result = @api.search("facebook")
+    expect(result.length).to be_an(Integer)
+  end
+
   # PAGING THROUGH COLLECTIONS
   # see also graph_collection_tests
   it "makes a request for a page when provided a specific set of page params" do
@@ -534,6 +546,7 @@ shared_examples_for "Koala GraphAPI with an access token" do
       :put_wall_post => 4,
       :put_comment => 3,
       :put_like => 2, :delete_like => 2,
+      :search => 3,
       :set_app_restrictions => 4,
       :get_page_access_token => 3,
       :fql_query => 3, :fql_multiquery => 3,
@@ -582,10 +595,26 @@ shared_examples_for "Koala GraphAPI with GraphCollection" do
       expect(@api.get_connections(KoalaTest.page, "photos")).to be_nil
     end
 
+    it "gets a GraphCollection when searching" do
+      result = @api.search("facebook")
+      expect(result).to be_a(Koala::Facebook::GraphCollection)
+    end
+
+    it "returns nil if the search call fails with nil" do
+      # this happens sometimes
+      expect(@api).to receive(:graph_call).and_return(nil)
+      expect(@api.search("facebook")).to be_nil
+    end
+
+    it "gets a GraphCollection when paging through results" do
+      @results = @api.get_page(["search", {"q"=>"facebook", "limit"=>"25", "until"=> KoalaTest.search_time}])
+      expect(@results).to be_a(Koala::Facebook::GraphCollection)
+    end
+
     it "returns nil if the page call fails with nil" do
       # this happens sometimes
       expect(@api).to receive(:graph_call).and_return(nil)
-      expect(@api.get_connections(KoalaTest.page, "photos")).to be_nil
+      expect(@api.get_page(["search", {"q"=>"facebook", "limit"=>"25", "until"=> KoalaTest.search_time}])).to be_nil
     end
   end
 end

data/spec/support/koala_test.rb

@@ -3,7 +3,7 @@ module KoalaTest
 
   class << self
     attr_accessor :oauth_token, :app_id, :secret, :app_access_token, :code, :session_key
-    attr_accessor :oauth_test_data, :subscription_test_data
+    attr_accessor :oauth_test_data, :subscription_test_data, :search_time
     attr_accessor :test_user_api
     attr_accessor :vcr_oauth_token
   end
@@ -107,6 +107,9 @@ module KoalaTest
     self.session_key = data["oauth_test_data"]["session_key"]
 
     self.vcr_oauth_token = data["vcr_data"]["oauth_token"]
+
+    # fix the search time so it can be used in the mock responses
+    self.search_time = data["search_time"] || (Time.now - 3600).to_s
   end
 
   def self.testing_permissions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 2.2.0rc2
+  version: 2.2.0rc3
 platform: ruby
 authors:
 - Alex Koppel