koala 2.5.0 → 3.0.0.beta1

data/lib/koala/api/rest_api.rb

@@ -1,135 +0,0 @@
-module Koala
-  module Facebook
-    # Methods used to interact with Facebook's legacy REST API.
-    # Where possible, you should use the newer, faster Graph API to interact with Facebook;
-    # in the future, the REST API will be deprecated.
-    # For now, though, there are a few methods that can't be done through the Graph API.
-    #
-    # When using the REST API, Koala will use Facebook's faster read-only servers 
-    # whenever the call allows.  
-    #
-    # See https://github.com/arsduo/koala/wiki/REST-API for a general introduction to Koala
-    # and the Rest API.
-    module RestAPIMethods
-      # Set a Facebook application's properties.
-      # 
-      # @param properties a hash of properties you want to update with their new values.
-      # @param (see #rest_call)
-      # @param options (see #rest_call)
-      #
-      # @return true if successful, false if not.  (This call currently doesn't give useful feedback on failure.)
-      def set_app_properties(properties, args = {}, options = {})
-        raise AuthenticationError.new(nil, nil, "setAppProperties requires an access token") unless @access_token
-        rest_call("admin.setAppProperties", args.merge(:properties => JSON.dump(properties)), options, "post")
-      end
-
-      # Make a call to the REST API. 
-      #
-      # @note The order of the last two arguments is non-standard (for historical reasons).  Sorry.
-      # 
-      # @param fb_method the API call you want to make
-      # @param args (see Koala::Facebook::GraphAPIMethods#graph_call)
-      # @param options (see Koala::Facebook::GraphAPIMethods#graph_call)
-      # @param verb (see Koala::Facebook::GraphAPIMethods#graph_call)
-      # 
-      # @raise [Koala::Facebook::APIError] if Facebook returns an error
-      # 
-      # @return the result from Facebook
-      def rest_call(fb_method, args = {}, options = {}, verb = "get")
-        Koala::Utils.deprecate("The REST API is now deprecated; please use the equivalent Graph API methods instead.  See http://developers.facebook.com/blog/post/616/.")
-
-        options = options.merge!(:rest_api => true, :read_only => READ_ONLY_METHODS.include?(fb_method.to_s))
-
-        api("method/#{fb_method}", args.merge('format' => 'json'), verb, options) do |response|
-          # check for REST API-specific errors
-          if response.status >= 400
-            begin
-              response_hash = JSON.load(response.body)
-            rescue JSON::ParserError
-              response_hash = {}
-            end
-
-            error_info = {
-              'code' => response_hash['error_code'],
-              'error_subcode' => response_hash['error_subcode'],
-              'message' => response_hash['error_msg']
-            }
-
-            if response.status >= 500
-              raise ServerError.new(response.status, response.body, error_info)
-            else
-              raise ClientError.new(response.status, response.body, error_info)
-            end
-          end
-        end
-      end
-
-      # @private
-      # read-only methods for which we can use API-read
-      # taken directly from the FB PHP library (https://github.com/facebook/php-sdk/blob/master/src/facebook.php)
-      READ_ONLY_METHODS = [
-        'admin.getallocation',
-        'admin.getappproperties',
-        'admin.getbannedusers',
-        'admin.getlivestreamvialink',
-        'admin.getmetrics',
-        'admin.getrestrictioninfo',
-        'application.getpublicinfo',
-        'auth.getapppublickey',
-        'auth.getsession',
-        'auth.getsignedpublicsessiondata',
-        'comments.get',
-        'connect.getunconnectedfriendscount',
-        'dashboard.getactivity',
-        'dashboard.getcount',
-        'dashboard.getglobalnews',
-        'dashboard.getnews',
-        'dashboard.multigetcount',
-        'dashboard.multigetnews',
-        'data.getcookies',
-        'events.get',
-        'events.getmembers',
-        'fbml.getcustomtags',
-        'feed.getappfriendstories',
-        'feed.getregisteredtemplatebundlebyid',
-        'feed.getregisteredtemplatebundles',
-        'fql.multiquery',
-        'fql.query',
-        'friends.arefriends',
-        'friends.get',
-        'friends.getappusers',
-        'friends.getlists',
-        'friends.getmutualfriends',
-        'gifts.get',
-        'groups.get',
-        'groups.getmembers',
-        'intl.gettranslations',
-        'links.get',
-        'notes.get',
-        'notifications.get',
-        'pages.getinfo',
-        'pages.isadmin',
-        'pages.isappadded',
-        'pages.isfan',
-        'permissions.checkavailableapiaccess',
-        'permissions.checkgrantedapiaccess',
-        'photos.get',
-        'photos.getalbums',
-        'photos.gettags',
-        'profile.getinfo',
-        'profile.getinfooptions',
-        'stream.get',
-        'stream.getcomments',
-        'stream.getfilters',
-        'users.getinfo',
-        'users.getloggedinuser',
-        'users.getstandardinfo',
-        'users.hasapppermission',
-        'users.isappuser',
-        'users.isverified',
-        'video.getuploadlimits'
-      ]
-    end
-
-  end # module Facebook
-end # module Koala

data/spec/support/rest_api_shared_examples.rb

@@ -1,168 +0,0 @@
-shared_examples_for "Koala RestAPI" do
-  # REST_CALL
-  describe "when making a rest request" do
-    it "uses the proper path" do
-      method = double('methodName')
-      expect(@api).to receive(:api).with(
-        "method/#{method}",
-        anything,
-        anything,
-        anything
-      )
-
-      @api.rest_call(method)
-    end
-
-    it "always uses the rest api" do
-      expect(@api).to receive(:api).with(
-        anything,
-        anything,
-        anything,
-        hash_including(:rest_api => true)
-      )
-
-      @api.rest_call('anything')
-    end
-
-    it "sets the read_only option to true if the method is listed in the read-only list" do
-      method = Koala::Facebook::API::READ_ONLY_METHODS.first
-
-      expect(@api).to receive(:api).with(
-        anything,
-        anything,
-        anything,
-        hash_including(:read_only => true)
-      )
-
-      @api.rest_call(method)
-    end
-
-    it "sets the read_only option to false if the method is not inthe read-only list" do
-      method = "I'm not a read-only method"
-
-      expect(@api).to receive(:api).with(
-        anything,
-        anything,
-        anything,
-        hash_including(:read_only => false)
-      )
-
-      @api.rest_call(method)
-    end
-
-
-    it "takes an optional hash of arguments" do
-      args = {:arg1 => 'arg1'}
-
-      expect(@api).to receive(:api).with(
-        anything,
-        hash_including(args),
-        anything,
-        anything
-      )
-
-      @api.rest_call('anything', args)
-    end
-
-    it "always asks for JSON" do
-      expect(@api).to receive(:api).with(
-        anything,
-        hash_including('format' => 'json'),
-        anything,
-        anything
-      )
-
-      @api.rest_call('anything')
-    end
-
-    it "passes any options provided to the API" do
-      options = {:a => 2}
-
-      expect(@api).to receive(:api).with(
-        anything,
-        hash_including('format' => 'json'),
-        anything,
-        hash_including(options)
-      )
-
-      @api.rest_call('anything', {}, options)
-    end
-
-    it "uses get by default" do
-      expect(@api).to 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'
-      expect(@api).to receive(:api).with(
-        anything,
-        anything,
-        method,
-        anything
-      )
-
-      @api.rest_call('anything', {}, {}, method)
-    end
-
-    it "throws an APIError if the status code >= 400" do
-      allow(Koala).to receive(:make_request).and_return(Koala::HTTPService::Response.new(500, '{"error_code": "An error occurred!"}', {}))
-      expect { @api.rest_call(KoalaTest.user1, {}) }.to raise_exception(Koala::Facebook::APIError)
-    end
-  end
-
-  it "can use the beta tier" do
-    @api.rest_call("fql.query", {:query => "select first_name from user where uid = #{KoalaTest.user2_id}"}, :beta => true)
-  end
-end
-
-shared_examples_for "Koala RestAPI with an access token" do
-  describe "#set_app_properties" do
-    it "sends Facebook the properties JSON-encoded as :properties" do
-      props = {:a => 2, :c => [1, 2, "d"]}
-      expect(@api).to receive(:rest_call).with(anything, hash_including(:properties => JSON.dump(props)), anything, anything)
-      @api.set_app_properties(props)
-    end
-
-    it "calls the admin.setAppProperties method" do
-      expect(@api).to receive(:rest_call).with("admin.setAppProperties", anything, anything, anything)
-      @api.set_app_properties({})
-    end
-
-    it "includes any other provided arguments" do
-      args = {:c => 3, :d => "a"}
-      expect(@api).to receive(:rest_call).with(anything, hash_including(args), anything, anything)
-      @api.set_app_properties({:a => 2}, args)
-    end
-
-    it "includes any http_options provided" do
-      opts = {:c => 3, :d => "a"}
-      expect(@api).to receive(:rest_call).with(anything, anything, opts, anything)
-      @api.set_app_properties({}, {}, opts)
-    end
-
-    it "makes a POST" do
-      expect(@api).to receive(:rest_call).with(anything, anything, anything, "post")
-      @api.set_app_properties({})
-    end
-
-    it "can set app properties using the app's access token" do
-      oauth = Koala::Facebook::OAuth.new(KoalaTest.app_id, KoalaTest.secret)
-      app_token = oauth.get_app_access_token
-      @app_api = Koala::Facebook::API.new(app_token)
-      expect(@app_api.set_app_properties(KoalaTest.app_properties)).to be_truthy
-    end
-  end
-end
-
-shared_examples_for "Koala RestAPI without an access token" do
-  it "can't use set_app_properties" do
-    expect { @api.set_app_properties(:desktop => 0) }.to raise_error(Koala::Facebook::AuthenticationError)
-  end
-end