koala 2.5.0 → 3.0.0

data/spec/support/koala_test.rb

@@ -106,8 +106,6 @@ module KoalaTest
     self.code = data["oauth_test_data"]["code"]
     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
@@ -157,12 +155,12 @@ module KoalaTest
     print "Validating permissions for live testing..."
     # make sure we have the necessary permissions
     api = Koala::Facebook::API.new(token)
-    perms = api.fql_query("select #{testing_permissions} from permissions where uid = me()")[0]
-    perms.each_pair do |perm, value|
-      if value == (perm == "read_insights" ? 1 : 0) # live testing depends on insights calls failing
-        puts "failed!\n" # put a new line after the print above
-        raise ArgumentError, "Your access token must have #{testing_permissions.join(", ")}, and lack read_insights.  You have: #{perms.inspect}"
-      end
+    perms = api.get_connect("me", "permissions")["data"]
+
+    # live testing depends on insights calls failing
+    if perms.keys.include?("read_insights") || (perms.keys & testing_permissions) != testing_permissions
+      puts "failed!\n" # put a new line after the print above
+      raise ArgumentError, "Your access token must have #{testing_permissions.join(", ")}, and lack read_insights.  You have: #{perms.inspect}"
     end
     puts "done!"
   end
@@ -183,7 +181,7 @@ module KoalaTest
   # Data for testing
   def self.user1
     # user ID, either numeric or username
-    test_user? ? @live_testing_user["id"] : "koppel"
+    test_user? ? @live_testing_user["id"] : "barackobama"
   end
 
   def self.user1_id
@@ -198,7 +196,7 @@ module KoalaTest
 
   def self.user2
     # see notes for user1
-    test_user? ? @live_testing_friend["id"] : "lukeshepard"
+    test_user? ? @live_testing_friend["id"] : "koppel"
   end
 
   def self.user2_id

data/spec/support/mock_http_service.rb

@@ -32,8 +32,8 @@ module Koala
     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.make_request(path, args, verb, options = {})
-      if response = match_response(path, args, verb, options)
+    def self.make_request(request)
+      if response = match_response(request.raw_path, request.raw_args, request.raw_verb, request.raw_options)
         # create response class object
         response_object = if response.is_a? String
           Koala::HTTPService::Response.new(200, response, {})
@@ -45,12 +45,12 @@ module Koala
         # 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 = [path, args, verb, options] * ': '
+        data_trace = [request.raw_path, request.raw_args, request.raw_verb, request.raw_options] * ': '
 
-        args = args == 'no_args' ? '' : "#{args}&"
+        args = request.raw_args == 'no_args' ? '' : "#{request.raw_args}&"
         args += 'format=json'
 
-        raise "Missing a mock response for #{data_trace}\nAPI PATH: #{[path, args].join('?')}"
+        raise "Missing a mock response for #{data_trace}\nAPI PATH: #{[request.path, request.raw_args].join('?')}"
       end
 
       response_object
@@ -65,7 +65,7 @@ module Koala
 
     # 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'
+      server = 'graph_api'
       path = 'root' if path == '' || path == '/'
       verb = (verb || 'get').to_s
       token = args.delete('access_token')
@@ -88,8 +88,8 @@ module Koala
       args = arguments.inject({}) do |hash, (k, v)|
         # ensure our args are all stringified
         value = if v.is_a?(String)
-          should_json_decode?(v) ? JSON.load(v) : v
-        elsif v.is_a?(Koala::UploadableIO)
+          should_json_decode?(v) ? JSON.parse(v) : v
+        elsif v.is_a?(Koala::HTTPService::UploadableIO)
           # obviously there are no files in the yaml
           "[FILE]"
         else
@@ -119,7 +119,7 @@ module Koala
         # 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) ? JSON.load(v) : v.to_s rescue v.to_s
+          value = should_json_decode?(v) ? JSON.parse(v) : v.to_s rescue v.to_s
           # some special-casing, unfortunate but acceptable in this testing
           # environment
           value = nil if value.empty?

data/spec/support/uploadable_io_shared_examples.rb

@@ -12,7 +12,7 @@ shared_examples_for "MIME::Types can't return results" do
       else
         @koala_io_params[0] = path
       end
-      expect(Koala::UploadableIO.new(*@koala_io_params).content_type).to eq(mime_type)
+      expect(Koala::HTTPService::UploadableIO.new(*@koala_io_params).content_type).to eq(mime_type)
     end
 
     it "should get content types for #{extension} using basic analysis with file names with more than one dot" do
@@ -22,7 +22,7 @@ shared_examples_for "MIME::Types can't return results" do
       else
         @koala_io_params[0] = path
       end
-      expect(Koala::UploadableIO.new(*@koala_io_params).content_type).to eq(mime_type)
+      expect(Koala::HTTPService::UploadableIO.new(*@koala_io_params).content_type).to eq(mime_type)
     end
   end
 
@@ -37,7 +37,7 @@ shared_examples_for "MIME::Types can't return results" do
     end
 
     it "should throw an exception" do
-      expect { Koala::UploadableIO.new(*@koala_io_params) }.to raise_exception(Koala::KoalaError)
+      expect { Koala::HTTPService::UploadableIO.new(*@koala_io_params) }.to raise_exception(Koala::KoalaError)
     end
   end
 end
@@ -47,7 +47,7 @@ shared_examples_for "determining a mime type" do
     it "should return an UploadIO with MIME::Types-determined type if the type exists" do
       type_result = ["type"]
       allow(Koala::MIME::Types).to receive(:type_for).and_return(type_result)
-      expect(Koala::UploadableIO.new(*@koala_io_params).content_type).to eq(type_result.first)
+      expect(Koala::HTTPService::UploadableIO.new(*@koala_io_params).content_type).to eq(type_result.first)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
 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
@@ -50,31 +64,31 @@ extra_rdoc_files:
 - readme.md
 - changelog.md
 files:
-- ".autotest"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
-- Guardfile
+- ISSUE_TEMPLATE
 - LICENSE
 - Manifest
+- PULL_REQUEST_TEMPLATE
 - Rakefile
-- autotest/discover.rb
 - changelog.md
 - code_of_conduct.md
 - koala.gemspec
 - lib/koala.rb
 - lib/koala/api.rb
 - lib/koala/api/batch_operation.rb
-- lib/koala/api/graph_api.rb
+- lib/koala/api/graph_api_methods.rb
 - lib/koala/api/graph_batch_api.rb
 - lib/koala/api/graph_collection.rb
 - lib/koala/api/graph_error_checker.rb
-- lib/koala/api/rest_api.rb
+- lib/koala/configuration.rb
 - lib/koala/errors.rb
 - lib/koala/http_service.rb
 - lib/koala/http_service/multipart_request.rb
+- lib/koala/http_service/request.rb
 - lib/koala/http_service/response.rb
 - lib/koala/http_service/uploadable_io.rb
 - lib/koala/oauth.rb
@@ -84,11 +98,14 @@ files:
 - lib/koala/version.rb
 - readme.md
 - spec/cases/api_spec.rb
+- spec/cases/configuration_spec.rb
 - spec/cases/error_spec.rb
 - spec/cases/graph_api_batch_spec.rb
 - spec/cases/graph_api_spec.rb
 - spec/cases/graph_collection_spec.rb
 - spec/cases/graph_error_checker_spec.rb
+- spec/cases/http_service/request_spec.rb
+- spec/cases/http_service/response_spec.rb
 - spec/cases/http_service_spec.rb
 - spec/cases/koala_spec.rb
 - spec/cases/koala_test_spec.rb
@@ -102,6 +119,7 @@ files:
 - spec/fixtures/cat.m4v
 - spec/fixtures/facebook_data.yml
 - spec/fixtures/mock_facebook_responses.yml
+- spec/fixtures/vcr_cassettes/app_test_accounts.yml
 - spec/fixtures/vcr_cassettes/friend_list_next_page.yml
 - spec/integration/graph_collection_spec.rb
 - spec/spec_helper.rb
@@ -109,7 +127,6 @@ files:
 - spec/support/graph_api_shared_examples.rb
 - spec/support/koala_test.rb
 - spec/support/mock_http_service.rb
-- spec/support/rest_api_shared_examples.rb
 - spec/support/uploadable_io_shared_examples.rb
 homepage: http://github.com/arsduo/koala
 licenses:
@@ -127,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -135,18 +152,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 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_spec.rb
+- spec/cases/configuration_spec.rb
 - spec/cases/error_spec.rb
 - spec/cases/graph_api_batch_spec.rb
 - spec/cases/graph_api_spec.rb
 - spec/cases/graph_collection_spec.rb
 - spec/cases/graph_error_checker_spec.rb
+- spec/cases/http_service/request_spec.rb
+- spec/cases/http_service/response_spec.rb
 - spec/cases/http_service_spec.rb
 - spec/cases/koala_spec.rb
 - spec/cases/koala_test_spec.rb
@@ -160,6 +180,7 @@ test_files:
 - spec/fixtures/cat.m4v
 - spec/fixtures/facebook_data.yml
 - spec/fixtures/mock_facebook_responses.yml
+- spec/fixtures/vcr_cassettes/app_test_accounts.yml
 - spec/fixtures/vcr_cassettes/friend_list_next_page.yml
 - spec/integration/graph_collection_spec.rb
 - spec/spec_helper.rb
@@ -167,6 +188,5 @@ test_files:
 - spec/support/graph_api_shared_examples.rb
 - spec/support/koala_test.rb
 - spec/support/mock_http_service.rb
-- spec/support/rest_api_shared_examples.rb
 - spec/support/uploadable_io_shared_examples.rb
 has_rdoc: 

data/.autotest

@@ -1,12 +0,0 @@
-# Override autotest default magic to rerun all tests every time a
-# change is detected on the file system.
-class Autotest
-  
-  def get_to_green
-    begin
-      rerun_all_tests
-      wait_for_changes unless all_good
-    end until all_good
-  end
-                            
-end

data/Guardfile

@@ -1,6 +0,0 @@
-guard 'rspec', :version => 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-

data/autotest/discover.rb

@@ -1 +0,0 @@
-Autotest.add_discovery { "rspec2" }

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