Changelog History
Page 1
-
v3.2.0 Changes
May 27, 2022๐ New features:
- Exposes limiting headers(
x-business-use-case-usage, x-ad-account-usage, x-app-usage
) to APIError (#668) - Add
rate_limit_hook
configuration to get rate limiting headers (x-business-use-case-usage, x-ad-account-usage, x-app-usage
) (#670)
โ Testing improvements:
- ๐ Fix builds for ruby 3.x
- Exposes limiting headers(
-
v3.1.0 Changes
January 18, 2022๐ New features:
- ๐ mask_tokens config (default: true) to mask tokens in logs
โก๏ธ Updated features:
- ๐ฒ Log before and after sending request
Internal improvements:
- ๐ Lock Faraday to < 2
- ๐ Compatibility with ruby 3.x
โ Testing improvements:
- ๐ Use Github actions for CI
- ๐ท Run CI on latest rubies
-
v3.0.0 Changes
March 17, 2017โฌ๏ธ Most users should not see any difference upgrading from 2.x to 3.0. Most of the changes are internal to how requests go from a graph method (like
get_connections
) through the API to the โฌ๏ธ HTTP layer and back. If you're not using API#api or HTTPService.make_request directly, upgrading should (in theory) require no code changes. (Let me know if you run into any issues.)Key breaking changes:
- ๐ Koala now requires Ruby 2.1+ (or equivalent for JRuby, etc.)
- API#api now returns a Koala::HTTPService::Response object; graph_call handles further processing
- GraphBatchAPI no longer inherits from API (the interface is otherwise unchanged)
- ๐ Empty response bodies in batch API calls will raise a JSON::ParserError rather than returning nil
- HTTPService.make_request now requires an HTTPService::Request object (Koala.make_request does not)
- HTTPService behavior should not change, but in edge cases might. (If so, please let me know.)
- API#search now requires a "type"/:type argument, matching Facebook's behavior (improving their cryptic error message)
๐ New features:
- ๐ Koala now supports global configuration for tokens, secrets, etc! See the readme.
- GraphCollection now exposes #headers, allowing access to etag/rate limiting/etc. info (thanks, pawandubey and jessieay!) (#589)
โก๏ธ Updated features:
- ๐ง Koala.config now uses a dedicated Koala::Configuration object
- โ TestUser#befriend will provide the appsecret_proof if a secret is set (thanks, kwasimensah!)
- API#search now requires an object type parameter to be included, matching Facebook's API (#575)
- โก๏ธ RealtimeUpdates will now only fetch the app access token if necessary, avoiding unnecessary calls
โ Removed features:
- โ Removed support for the Rest API, since Facebook removed support for it (#568)
- โ Removed support for FQL, which Facebook removed on August 8, 2016 (#569)
- โ Removed legacy duplication of serveral constants in the Koala module (#569)
- Removed API#get_comments_for_urls, which pointed to a no-longer-extant endpoint(#570)
Internal improvements:
- Completely rewrote HTTPService.make_request and several others, extracting most logic into HTTPService::Request (#566)
- API#api now returns a Koala::HTTPService::Response object (#584)
- GraphBatchAPI no longer inherits from API (#580)
- ๐จ GraphBatchAPI has been refactored to be simpler and more readable (thanks, acuppy!) (#551)
- ๐ Use the more secure JSON.parse instead of JSON.load (thanks, lautis!) (#567)
- ๐ Use JSON's quirks_mode option to remove hacky JSON hack (#573 -- thanks sakuro for the suggestion!)
- The gemspec now allows both JSON 1.8 and 2.0 (#596) (thanks, pawandubey!)
- โ Remove Autotest and Guard references (no longer used/needed)
โ Testing improvements:
- ๐ Fixed a bunch of failing mocked specs
Others:
- โ Added an issue and pull request template
- โก๏ธ Updated Code of Conduct to 1.4
-
v2.5.0 Changes
February 17, 2017๐ New features:
- API#get_object_metadata provides a convenient accessor to an object's graph metadata (thanks, sancopanco!)
๐ Documentation improvements:
- โ Add explicit require to examples in readme.md (thanks, dwkns!)
Internal improvements:
- โ Remove MultiJson dependency (thanks, sakuro!)
-
v2.4.0 Changes
July 08, 2016Note: Koala is no longer officially supported on Ruby 1.9.3 (which was end-of-lifed back in ๐ 2015). Versions may โ still work (until version 3.0, when we may start using keyword arguments), but will not be tested on 1.9.3.
โก๏ธ Updated features:
- Batch API requests will now properly calculate appsecret_proofs for multiple access tokens (thanks, mwpastore!)
Internal improvements:
- Koala now explicitly depends on MultiJson >= 1.3.0, since it uses methods introduced in that version
โ Testing improvements:
- โ Test Koala against Ruby 2.3.0 (thanks, thedrow!)
-
v2.3.0 Changes
April 10, 2016โก๏ธ Updated features:
- ๐ API#get_user_picture_data is now API#get_picture_data. The old method and API#get_picture both remain with deprecation warnings. (Thanks noahsilas for earlier work on this!)
- Koala::Facebook::APIError now includes debug and trace info provided by Facebook in the headers (thanks, @elhu!)
Internal Improvements:
- Graph API error handling is now done via the GraphErrorChecker class
โ Testing improvements:
- โฌ๏ธ Upgraded RSpec to 3.3.0
- โ Removed pended specs that were no longer relevant
- ๐ Improved https regex in test suite (thanks, lucaskds!)
-
v2.2.0 Changes
August 11, 2015โก๏ธ 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!)
Internal Improvements:
- ๐ Use MultiJson::LoadError instead of the newer ParseError for backward compatibility (thanks, bunshin!)
๐ Documentation improvements:
- modernize the hash syntax in the readme (thanks, st0012!)
-
v2.1.0 Changes
๐ Documentation improvements:
- extend/clean up code quality badges (thanks, jbender!)
-
v2.0.0 Changes
๐จ Koala 2.0 is not a major refactor, but rather a set of small, mostly internal ๐จ refactors:
- BatchAPI now reads both access token and app secret from the original API instance (thanks, lukeasrodgers!)
- โ Remove legacy interfaces (deprecated since 1.2)
- API#search (which Facebook doesn't support anymore)
- TestUser#graph_api and RealtimeUpdates#graph_api (use #api instead)
- Various HTTP options (see diff for deprecation warnings/upgrade instructions for each method)
- NetHTTPService and TyphoeusHTTPService (see diff for deprecation warnings/upgrade instructions)
- OAuth methods for dealing with session tokens (which Facebook stopped providing)
- OAuth#get_user_from_cookies (use get_user_info_from_cookies instead)
- Blocks passed to API#get_picture will work in the batch API (thanks, cwhetung!)
- ๐ Added API#get_user_picture_data to get data about a picture (thanks, morgoth!)
Other changes:
- โ Test against modern Ruby versions on Travis (thanks, nicolasleger!)
- ๐ Speed up Travis builds (thanks, morgoth!)
-
v1.11.1 Changes
๐ Bug fixes:
- Properly import Facebook error attributes (thanks, isra17!)