koala 3.0.0.beta3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ed893e5254cc1e5b3007301dc847bd025b592c1
-  data.tar.gz: 3ad942cb33ac7e7a36304250dd3cc7c6b36712f8
+SHA256:
+  metadata.gz: 3209d60dbf8ab51fac40f7b990f221076bb453329641194dce55b800d0611856
+  data.tar.gz: 9dfb75f13c1b1e187c325453793b6dfcdc085a0f42e119d40df7a30d7b492250
 SHA512:
-  metadata.gz: 6d4cac2752f9b72f7c1c1cf4632dfaf10b7ba9b72753699540587e3b636b35fde33ca2035b47e468d51d59c490ce9dcbc624618d5eb10e1da3b5fc4c2a11f034
-  data.tar.gz: 4728dfc6777f3e1b29d2dcab6608c9a40f24e8ee8a2136940ed2b463846ddcffa9c0f0afd96a1ab8d21b2d2c0203bdde5ddfe0c4a8ee1d250650921361343c90
+  metadata.gz: 2aa7c4c61594d111e5654788712a56eea9005e4e3f6ce133536de6d2089f6014a6a0f5a059012b3bccf2204862b6c28212b517a4a264ea4b2cc272530d11cb4f
+  data.tar.gz: 318d505d832d0d2e70cd9df39040254c1eea64bdf3c743cf29c6311e8fe2cd68159f3237a27a6a066136b5d3306029771fae2935fc4c768860a2c12525f29137

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: on ruby ${{matrix.ruby}}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, "3.0", 3.1, head]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+
+    - name: Install dependencies
+      run: bundle install --jobs 4 --retry 3
+
+    - name: Specs & Coverage
+      uses: paambaati/codeclimate-action@v3.0.0
+      env:
+        CC_TEST_REPORTER_ID: 7af99d9225b4c14640f9ec3cb2e24d2f7103ac49417b0bd989188fb6c25f2909
+      with:
+        coverageCommand: bundle exec rspec

data/Gemfile

@@ -7,15 +7,16 @@ group :development do
 end
 
 group :development, :test do
+  gem "psych", '< 4.0.0' # safe_load signature not compatible with older rubies
   gem "rake"
   gem "typhoeus" unless defined? JRUBY_VERSION
 end
 
 group :test do
   gem "rspec", '~> 3.4'
-  gem "vcr"
+  gem "vcr", github: 'vcr/vcr', ref: '8ced6c96e01737a418cd270e0382a8c2c6d85f7f' # needs https://github.com/vcr/vcr/pull/907 for ruby 3.1
   gem "webmock"
-  gem "codeclimate-test-reporter", "~> 1.0.0", require: nil
+  gem "simplecov"
 end
 
 gem "jruby-openssl" if defined? JRUBY_VERSION

data/ISSUE_TEMPLATE

@@ -8,16 +8,18 @@ Koala is a labor of love both from me and from the awesome community members who
 
 If you have questions about using the Facebook API, [facebook.stackoverflow.com](http://facebook.stackoverflow.com) is a great resource.
 
-For code issues:
+_For code issues:_
 
 [ ] What I'm doing works on the [Graph API explorer](https://developers.facebook.com/tools/explorer/)/curl/another tool.
 
 Seeing an example of what works helps diagnose what doesn't work.
 
 [ ] I'm using the newest version
-
 [ ] Here's code to replicate the issue:
 
 Obviously not all code can be shared -- feel free to put variables in place of any sensitive information and describe what should be used to replicate it.
 
 Thanks for submitting an issue! Looking forward to working with you to figure it out.
+
+
+Note: Koala has a [code of conduct](https://github.com/arsduo/koala/blob/master/code_of_conduct.md). Check it out.

data/PULL_REQUEST_TEMPLATE

@@ -6,4 +6,6 @@ Here are a few things that will help get your pull request merged in quickly. No
 [ ] The live tests pass for my changes (`LIVE=true rspec` -- unrelated failures are okay).
 [ ] The PR is based on the most recent master commit and has no merge conflicts.
 
-If you have any questions, feel free to open an issue or comment on your PR!
+If you have any questions, feel free to open an issue or comment on your PR!
+
+Note: Koala has a [code of conduct](https://github.com/arsduo/koala/blob/master/code_of_conduct.md). Check it out.

data/changelog.md

@@ -1,4 +1,42 @@
-v3.0.0 (not released yet)
+Unreleased
+==========
+
+**Key breaking changes:**
+
+New features:
+
+Updated features:
+
+Removed features:
+
+Internal improvements:
+
+Testing improvements:
+
+Others:
+
+v3.1.0 (2022-18-01)
+======
+
+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 (2017-03-17)
 ======
 
 Most users should not see any difference upgrading from 2.x to 3.0. Most of the changes are
@@ -29,6 +67,7 @@ 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:
 
@@ -47,6 +86,8 @@ Internal improvements:
 * 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:
 
@@ -55,6 +96,7 @@ Testing improvements:
 Others:
 
 * Added an issue and pull request template
+* Updated Code of Conduct to 1.4
 
 v2.5.0 (2017-02-17)
 ======

data/code_of_conduct.md

@@ -1,22 +1,74 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic addresses, without explicit permission
-* Other unethical or unprofessional conduct.
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
-This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+## Attribution
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/koala.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.1'
 
-  gem.add_runtime_dependency("faraday")
+  gem.add_runtime_dependency("faraday", "< 2")
   gem.add_runtime_dependency("addressable")
-  gem.add_runtime_dependency("json", ">= 2.0")
+  gem.add_runtime_dependency("json", ">= 1.8")
+  gem.add_runtime_dependency("rexml")
 end

data/lib/koala/api/graph_batch_api.rb

@@ -8,6 +8,9 @@ module Koala
       # inside a batch call we can do anything a regular Graph API can do
       include GraphAPIMethods
 
+      # Limits from @see https://developers.facebook.com/docs/marketing-api/batch-requests/v2.8
+      MAX_CALLS = 50
+
       attr_reader :original_api
       def initialize(api)
         @original_api = api
@@ -35,26 +38,34 @@ module Koala
         nil # batch operations return nothing immediately
       end
 
-      # execute the queued batch calls
+      # execute the queued batch calls. limits it to 50 requests per call.
+      # NOTE: if you use `name` and JsonPath references, you should ensure to call `execute` for each
+      # co-reference group and that the group size is not greater than the above limits.
       def execute(http_options = {})
         return [] if batch_calls.empty?
 
-        # Turn the call args collected into what facebook expects
-        args = {"batch" => batch_args}
-        batch_calls.each do |call|
-          args.merge! call.files || {}
-        end
+        batch_results = []
+        batch_calls.each_slice(MAX_CALLS) do |batch|
+          # Turn the call args collected into what facebook expects
+          args = {"batch" => batch_args(batch)}
+          batch.each do |call|
+            args.merge!(call.files || {})
+          end
 
-        original_api.graph_call("/", args, "post", http_options) do |response|
-          raise bad_response if response.nil?
-          generate_results(response)
+          original_api.graph_call("/", args, "post", http_options) do |response|
+            raise bad_response if response.nil?
+
+            batch_results += generate_results(response, batch)
+          end
         end
+
+        batch_results
       end
 
-      def generate_results(response)
+      def generate_results(response, batch)
         index = 0
         response.map do |call_result|
-          batch_op = batch_calls[index]
+          batch_op = batch[index]
           index += 1
           post_process = batch_op.post_processing
 
@@ -104,8 +115,8 @@ module Koala
         GraphErrorChecker.new(code, body, headers).error_if_appropriate
       end
 
-      def batch_args
-        calls = batch_calls.map do |batch_op|
+      def batch_args(calls_for_batch)
+        calls = calls_for_batch.map do |batch_op|
           batch_op.to_batch_params(access_token, app_secret)
         end
 

data/lib/koala/api.rb

@@ -102,7 +102,7 @@ module Koala
         args = sanitize_request_parameters(args) unless preserve_form_arguments?(options)
 
         # add a leading / if needed...
-        path = "/#{path}" unless path =~ /^\//
+        path = "/#{path}" unless path.to_s =~ /^\//
 
         # make the request via the provided service
         result = Koala.make_request(path, args, verb, options)

data/lib/koala/configuration.rb

@@ -28,6 +28,9 @@ class Koala::Configuration
   # The server to use when constructing dialog URLs.
   attr_accessor :dialog_host
 
+  # Whether or not to mask tokens
+  attr_accessor :mask_tokens
+
   # Certain Facebook services (beta, video) require you to access different
   # servers. If you're using your own servers, for instance, for a proxy,
   # you can change both the matcher (what value to change when updating the URL) and the
@@ -45,5 +48,6 @@ class Koala::Configuration
     Koala::HTTPService::DEFAULT_SERVERS.each_pair do |key, value|
       self.public_send("#{key}=", value)
     end
+    self.mask_tokens = true
   end
 end

data/lib/koala/http_service.rb

@@ -49,6 +49,18 @@ module Koala
       # set up our Faraday connection
       conn = Faraday.new(request.server, faraday_options(request.options), &(faraday_middleware || DEFAULT_MIDDLEWARE))
 
+      filtered_args = request.raw_args.dup.transform_keys(&:to_s)
+
+      if Koala.config.mask_tokens
+        %w(access_token input_token).each do |arg_token|
+          if (token = filtered_args[arg_token])
+            filtered_args[arg_token] = token[0, 10] + '*****' + token[-5, 5]
+          end
+        end
+      end
+
+      Koala::Utils.debug "STARTED => #{request.verb.upcase}: #{request.path} params: #{filtered_args.inspect}"
+
       if request.verb == "post" && request.json?
         # JSON requires a bit more handling
         # remember, all non-GET requests are turned into POSTs, so this covers everything but GETs
@@ -62,8 +74,7 @@ module Koala
         response = conn.send(request.verb, request.path, request.post_args)
       end
 
-      # Log URL information
-      Koala::Utils.debug "#{request.verb.upcase}: #{request.path} params: #{request.raw_args.inspect}"
+      Koala::Utils.debug "FINISHED => #{request.verb.upcase}: #{request.path} params: #{filtered_args.inspect}"
       Koala::HTTPService::Response.new(response.status.to_i, response.body, response.headers)
     end
 

data/lib/koala/realtime_updates.rb

@@ -7,9 +7,6 @@ module Koala
       # @note: to subscribe to real-time updates, you must have an application access token
       #        or provide the app secret when initializing your RealtimeUpdates object.
 
-      # The application API interface used to communicate with Facebook.
-      # @return [Koala::Facebook::API]
-      attr_reader :api
       attr_reader :app_id, :app_access_token, :secret
 
       # Create a new RealtimeUpdates instance.
@@ -29,14 +26,21 @@ module Koala
         unless @app_id && (@app_access_token || @secret) # make sure we have what we need
           raise ArgumentError, "Initialize must receive a hash with :app_id and either :app_access_token or :secret! (received #{options.inspect})"
         end
+      end
 
-        # fetch the access token if we're provided a secret
-        if @secret && !@app_access_token
-          oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-          @app_access_token = oauth.get_app_access_token
-        end
+      # The app access token, either provided on initialization or fetched from Facebook using the
+      # app_id and secret.
+      def app_access_token
+        # If a token isn't provided but we need it, fetch it
+        @app_access_token ||= Koala::Facebook::OAuth.new(@app_id, @secret).get_app_access_token
+      end
 
-        @api = API.new(@app_access_token)
+      # The application API interface used to communicate with Facebook.
+      # @return [Koala::Facebook::API]
+      def api
+        # Only instantiate the API if needed. validate_update doesn't require it, so we shouldn't
+        # make an unnecessary request to get the app_access_token.
+        @api ||= API.new(app_access_token)
       end
 
       # Subscribe to realtime updates for certain fields on a given object (user, page, etc.).
@@ -60,7 +64,7 @@ module Koala
           :callback_url => callback_url,
         }.merge(verify_token ? {:verify_token => verify_token} : {})
         # a subscription is a success if Facebook returns a 200 (after hitting your server for verification)
-        @api.graph_call(subscription_path, args, 'post', options)
+        api.graph_call(subscription_path, args, 'post', options)
       end
 
       # Unsubscribe from updates for a particular object or from updates.
@@ -71,7 +75,7 @@ module Koala
       #
       # @raise A subclass of Koala::Facebook::APIError if the subscription request failed.
       def unsubscribe(object = nil, options = {})
-        @api.graph_call(subscription_path, object ? {:object => object} : {}, "delete", options)
+        api.graph_call(subscription_path, object ? {:object => object} : {}, "delete", options)
       end
 
       # List all active subscriptions for this application.
@@ -80,7 +84,7 @@ module Koala
       #
       # @return [Array] a list of active subscriptions
       def list_subscriptions(options = {})
-        @api.graph_call(subscription_path, {}, "get", options)
+        api.graph_call(subscription_path, {}, "get", options)
       end
 
       # As a security measure (to prevent DDoS attacks), Facebook sends a verification request to your server
@@ -129,12 +133,13 @@ module Koala
           raise AppSecretNotDefinedError, "You must init RealtimeUpdates with your app secret in order to validate updates"
         end
 
-        if request_signature = headers['X-Hub-Signature'] || headers['HTTP_X_HUB_SIGNATURE'] and
-           signature_parts = request_signature.split("sha1=")
-          request_signature = signature_parts[1]
-          calculated_signature = OpenSSL::HMAC.hexdigest('sha1', @secret, body)
-          calculated_signature == request_signature
-        end
+        request_signature = headers['X-Hub-Signature'] || headers['HTTP_X_HUB_SIGNATURE']
+        return unless request_signature
+
+        signature_parts = request_signature.split("sha1=")
+        request_signature = signature_parts[1]
+        calculated_signature = OpenSSL::HMAC.hexdigest('sha1', @secret, body)
+        calculated_signature == request_signature
       end
 
       # The Facebook subscription management URL for your application.

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "3.0.0.beta3"
+  VERSION = "3.1.0"
 end

data/readme.md

@@ -1,6 +1,6 @@
-Koala [![Version](https://img.shields.io/gem/v/koala.svg)](https://rubygems.org/gems/koala) [![Dependencies](https://img.shields.io/gemnasium/arsduo/koala.svg)](https://gemnasium.com/arsduo/koala) [![Build Status](https://img.shields.io/travis/arsduo/koala.svg)](http://travis-ci.org/arsduo/koala) [![Code Climate](https://img.shields.io/codeclimate/github/arsduo/koala.svg)](https://codeclimate.com/github/arsduo/koala) [![Code Coverage](https://img.shields.io/codeclimate/coverage/github/arsduo/koala.svg)](https://codeclimate.com/github/arsduo/koala)
+Koala [![Version](https://img.shields.io/gem/v/koala.svg)](https://rubygems.org/gems/koala) [![Build Status](https://img.shields.io/travis/arsduo/koala.svg)](http://travis-ci.org/arsduo/koala) [![Code Climate](https://img.shields.io/codeclimate/coverage-letter/arsduo/koala.svg)](https://codeclimate.com/github/arsduo/koala) [![Code Coverage](https://img.shields.io/codeclimate/coverage/arsduo/koala.svg)](https://codeclimate.com/github/arsduo/koala)
 ====
-[Koala](http://github.com/arsduo/koala) is a Facebook library for Ruby, supporting the Graph API (including the batch requests and photo uploads), realtime updates, test users, and OAuth validation.  We wrote Koala with four goals:
+[Koala](http://github.com/arsduo/koala) is a Facebook library for Ruby, supporting the Graph API (including the batch requests and photo uploads), the Marketing API, the Atlas API, realtime updates, test users, and OAuth validation.  We wrote Koala with four goals:
 
 * Lightweight: Koala should be as light and simple as Facebook’s own libraries, providing API accessors and returning simple JSON.
 * Fast: Koala should, out of the box, be quick. Out of the box, we use Facebook's faster read-only servers when possible and if available, the Typhoeus gem to make snappy Facebook requests.  Of course, that brings us to our next topic:
@@ -12,27 +12,23 @@ Koala [![Version](https://img.shields.io/gem/v/koala.svg)](https://rubygems.org/
 Installation
 ------------
 
-**Koala 3.0 is in beta! There should be no significant changes** for most users -- please check it
-out!
+**Koala 3.0 is out! There should be no significant changes** for most users. If you encounter any
+problems, please file an issue and I'll take a look.
 
 In Bundler:
 ```ruby
-gem "koala", "~> 3.0.0.beta2"
-# if you need the previous release
-gem "koala", "~> 2.4"
+gem "koala"
 ```
 
 Otherwise:
 ```bash
-[sudo|rvm] gem install koala --pre
-# if you need the previous release
 [sudo|rvm] gem install koala
 ```
 
 Configuration
 -------------
 
-Most applications will only use one application configuration. Rather than having toprovide that
+Most applications will only use one application configuration. Rather than having to provide that
 value every time, you can configure Koala to use global settings:
 
 ```ruby

data/spec/cases/graph_api_batch_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'json' unless Hash.respond_to?(:to_json)
 
 describe "Koala::Facebook::GraphAPI in batch mode" do
 
@@ -468,6 +469,46 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
         expect(thread_one_count).to eq(first_count)
         expect(thread_two_count).to eq(second_count)
       end
+
+    end
+  end
+
+  describe '#big_batches' do
+    before :each do
+      payload = [{code: 200, headers: [{name: "Content-Type", value: "text/javascript; charset=UTF-8"}], body: "{\"id\":\"1234\"}"}]
+      allow(Koala).to receive(:make_request) do |_request, args, _verb, _options|
+        request_count = JSON.parse(args['batch']).length
+        expect(request_count).to be <= 50   # check FB's limit
+        Koala::HTTPService::Response.new(200, (payload * request_count).to_json, {})
+      end
+    end
+
+    it 'stays within fb limits' do
+      count_calls = 0
+      expected_calls = 100
+      @api.batch do |batch_api|
+        expected_calls.times { |_i| batch_api.get_object('me') { |_ret| count_calls += 1 } }
+      end
+
+      expect(count_calls).to eq(expected_calls)
+    end
+
+    it 'is recursive safe' do
+      # ensure batch operations whose callbacks call batch operations don't resubmit
+      call_count = 0
+      iterations = 60
+      @api.batch do |batch_api|
+        # must do enough calls to provoke a batch submission
+        iterations.times { |_i|
+          batch_api.get_object('me') { |_ret|
+            call_count += 1
+            batch_api.get_object('me') { |_ret|
+              call_count += 1
+            }
+          }
+        }
+      end
+      expect(call_count).to eq(2 * iterations)
     end
   end
 

data/spec/cases/http_service_spec.rb

@@ -122,7 +122,8 @@ describe Koala::HTTPService do
 
     let(:verb) { "get" }
     let(:options) { {} }
-    let(:request) { Koala::HTTPService::Request.new(path: "/foo", verb: verb, args: {"an" => :arg}, options: options) }
+    let(:args) { {"an" => :arg } }
+    let(:request) { Koala::HTTPService::Request.new(path: "/foo", verb: verb, args: args, options: options) }
 
     shared_examples_for :making_a_request do
       before :each do
@@ -153,7 +154,8 @@ describe Koala::HTTPService do
 
       it "logs verb, url and params to debug" do
         log_message = "#{verb.upcase}: #{request.path} params: #{request.raw_args.inspect}"
-        expect(Koala::Utils.logger).to receive(:debug).with(log_message)
+        expect(Koala::Utils.logger).to receive(:debug).with("STARTED => #{log_message}")
+        expect(Koala::Utils.logger).to receive(:debug).with("FINISHED => #{log_message}")
 
         Koala::HTTPService.make_request(request)
       end
@@ -230,5 +232,42 @@ describe Koala::HTTPService do
 
       Koala::HTTPService.make_request(request)
     end
+
+    context 'log_tokens configuration' do
+      let(:args) { { "an" => :arg, "access_token" => "myvisbleaccesstoken" } }
+
+      before(:each) do
+        allow_any_instance_of(Faraday::Connection).to receive(:get) { double(status: '200', body: 'ok', headers: {}) }
+      end
+
+      it 'logs tokens' do
+        allow(Koala.config).to receive(:mask_tokens) { false }
+
+        expect(Koala::Utils).to receive(:debug).with('STARTED => GET: /foo params: {"an"=>:arg, "access_token"=>"myvisbleaccesstoken"}')
+        expect(Koala::Utils).to receive(:debug).with('FINISHED => GET: /foo params: {"an"=>:arg, "access_token"=>"myvisbleaccesstoken"}')
+
+        Koala::HTTPService.make_request(request)
+      end
+
+      it 'doesnt log tokens' do
+        allow(Koala.config).to receive(:mask_tokens) { true }
+
+        expect(Koala::Utils).to receive(:debug).with('STARTED => GET: /foo params: {"an"=>:arg, "access_token"=>"myvisbleac*****token"}')
+        expect(Koala::Utils).to receive(:debug).with('FINISHED => GET: /foo params: {"an"=>:arg, "access_token"=>"myvisbleac*****token"}')
+
+        Koala::HTTPService.make_request(request)
+      end
+
+      it 'hides the token for the debug_token api endpoint' do
+        request = Koala::HTTPService::Request.new(path: "/debug_token", verb: verb, args: { input_token: 'myvisibleaccesstoken', 'access_token' => 'myvisibleaccesstoken' }, options: options)
+
+        allow(Koala.config).to receive(:mask_tokens) { true }
+
+        expect(Koala::Utils).to receive(:debug).with('STARTED => GET: /debug_token params: {"input_token"=>"myvisiblea*****token", "access_token"=>"myvisiblea*****token"}')
+        expect(Koala::Utils).to receive(:debug).with('FINISHED => GET: /debug_token params: {"input_token"=>"myvisiblea*****token", "access_token"=>"myvisiblea*****token"}')
+
+        Koala::HTTPService.make_request(request)
+      end
+    end
   end
 end

data/spec/cases/realtime_updates_spec.rb

@@ -106,25 +106,24 @@ describe "Koala::Facebook::RealtimeUpdates" do
       expect(updates).to be_a(Koala::Facebook::RealtimeUpdates)
     end
 
-    it "fetches an app_token from Facebook when provided an app_id and a secret" do
-      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
-      expect(updates.app_access_token).not_to be_nil
+    it "sets up the API with the app access token" do
+      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :app_access_token => @app_access_token)
+      expect(updates.api).to be_a(Koala::Facebook::API)
+      expect(updates.api.access_token).to eq(@app_access_token)
     end
+  end
 
-    it "uses the OAuth class to fetch a token when provided an app_id and a secret" do
-      oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-      token = oauth.get_app_access_token
-      expect(oauth).to receive(:get_app_access_token).and_return(token)
-      expect(Koala::Facebook::OAuth).to receive(:new).with(@app_id, @secret).and_return(oauth)
+  describe "#app_access_token" do
+    it "fetches an app_token from Facebook when provided an app_id and a secret" do
+      # integration test
       updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
+      expect(updates.app_access_token).not_to be_nil
     end
 
-    it "sets up the with the app acces token" do
-      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :app_access_token => @app_access_token)
-      expect(updates.api).to be_a(Koala::Facebook::API)
-      expect(updates.api.access_token).to eq(@app_access_token)
+    it "returns the provided token if provided" do
+      updates = Koala::Facebook::RealtimeUpdates.new(app_id: @app_id, app_access_token: @app_access_token)
+      expect(updates.app_access_token).to eq(@app_access_token)
     end
-
   end
 
   describe "#subscribe" do

data/spec/fixtures/facebook_data.yml

@@ -5,9 +5,7 @@
 # by enter an OAuth token, code, and session_key (for real users) or changing the app_id and secret (for test users)
 # (note for real users: this will leave some photos and videos posted to your wall, since they can't be deleted through the API)
 
-# These values are configured to work with the OAuth Playground app by default
-# Of course, you can change this to work with your own app.
-# Check out http://oauth.twoalex.com/ to easily generate tokens, cookies, etc.
+# These values are configured to work with a test app. If you want, you can change this to work with your own app.
 
 # Your OAuth token should have the read_stream, publish_stream, user_photos, user_videos, and read_insights permissions.
 oauth_token:
@@ -22,7 +20,7 @@ oauth_test_data:
   # These values will work out of the box
   app_id: 119908831367602
   secret: e45e55a333eec232d4206d2703de1307
-  callback_url: http://oauth.twoalex.com/
+  callback_url: http://testdomain.koalatest.test/
   app_access_token: 119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.
   raw_token_string: "access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.&expires=6621"
   raw_offline_access_token_string: access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.
@@ -54,7 +52,7 @@ oauth_test_data:
       issued_at: 1301917299
 
 subscription_test_data:
-  subscription_path: https://oauth.twoalex.com/subscriptions
+  subscription_path: https://testdomain.koalatest.test/subscriptions
   verify_token: "myverificationtoken|1f54545d5f722733e17faae15377928f"
   challenge_data:
     "hub.challenge": "1290024882"
@@ -62,4 +60,4 @@ subscription_test_data:
     "hub.mode": "subscribe"
 
 vcr_data:
-  oauth_token: CAACEdEose0cBAKuiUM40KZBEsq2l0iggaMGZBPI74svGQRMmZCPXb7eZCYPhNUbVXnnYZCjXKFKIc7HgYllr4RDIKrANHm6kKncOx0Y3UpDqLliRGZAnSEUypyFworUnBMOQJBlAuB1wlwYJZB7LIZCobCcnT2q9QwrZBpK3qAZB3u7ZAJaZAdsMZBsyALkAXatoj75leWXhgXfT1QiJHZBGoRlz07Q85z1dZBReK4ZD
+  oauth_token: CAACEdEose0cBAKuiUM40KZBEsq2l0iggaMGZBPI74svGQRMmZCPXb7eZCYPhNUbVXnnYZCjXKFKIc7HgYllr4RDIKrANHm6kKncOx0Y3UpDqLliRGZAnSEUypyFworUnBMOQJBlAuB1wlwYJZB7LIZCobCcnT2q9QwrZBpK3qAZB3u7ZAJaZAdsMZBsyALkAXatoj75leWXhgXfT1QiJHZBGoRlz07Q85z1dZBReK4ZD

data/spec/fixtures/mock_facebook_responses.yml

@@ -144,10 +144,10 @@ graph_api:
     message=Hello, world, from the test suite batch API!:
       post:
         with_token: '{"id": "FEED_ITEM_BATCH"}'
-    link=http://oauth.twoalex.com/&message=Hello, world, from the test suite again!&name=OAuth Playground:
+    link=http://testdomain.koalatest.test/&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=<%= JSON.dump({"Link1"=>{"text"=>"Left", "href"=>"http://oauth.twoalex.com/"}, "other" => {"text"=>"Straight ahead", "href"=>"http://oauth.twoalex.com/?"}}) %>&type=link:
+    link=http://testdomain.koalatest.test/&message=body&name=It's a big question&picture=http://testdomain.koalatest.test//images/logo.png&properties=<%= JSON.dump({"Link1"=>{"text"=>"Left", "href"=>"http://testdomain.koalatest.test/"}, "other" => {"text"=>"Straight ahead", "href"=>"http://testdomain.koalatest.test/?"}}) %>&type=link:
       post:
         with_token: '{"id": "FEED_ITEM_DICTIONARY"}'
 
@@ -367,12 +367,12 @@ graph_api:
         with_token:
           code: 200
       get:
-        with_token: '{"data":[{"callback_url":"https://oauth.twoalex.com/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
+        with_token: '{"data":[{"callback_url":"https://testdomain.koalatest.test/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
 
 
     callback_url=<%= SUBSCRIPTION_DATA["subscription_path"] %>:
       get:
-        with_token: '{"data":[{"callback_url":"https://oauth.twoalex.com/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
+        with_token: '{"data":[{"callback_url":"https://testdomain.koalatest.test/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
 
 # -- Mock Item Responses --
 
@@ -394,13 +394,13 @@ graph_api:
     no_args:
       <<: *item_deleted
       get:
-        with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground"}'
+        with_token: '{"link":"http://testdomain.koalatest.test/", "name": "OAuth Playground"}'
 
   /FEED_ITEM_DICTIONARY:
     no_args:
       <<: *item_deleted
       get:
-        with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground", "properties": {}}'
+        with_token: '{"link":"http://testdomain.koalatest.test/", "name": "OAuth Playground", "properties": {}}'
 
   /FEED_ITEM_CATS:
     no_args:

data/spec/fixtures/vcr_cassettes/app_test_accounts.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://graph.facebook.com/v2.8/119908831367602/accounts?access_token=**
+    uri: https://graph.facebook.com/v2.8/119908831367602/accounts?access_token=********************
     body:
       encoding: US-ASCII
       string: ''

data/spec/support/graph_api_shared_examples.rb

@@ -175,7 +175,7 @@ shared_examples_for "Koala GraphAPI with an access token" do
   end
 
   it "can post a message with an attachment to a feed" do
-    result = @api.put_wall_post("Hello, world, from the test suite again!", {:name => "OAuth Playground", :link => "http://oauth.twoalex.com/"})
+    result = @api.put_wall_post("Hello, world, from the test suite again!", {:name => "OAuth Playground", :link => "http://testdomain.koalatest.test/"})
     @temporary_object_id = result["id"]
     expect(@temporary_object_id).not_to be_nil
   end
@@ -311,7 +311,7 @@ shared_examples_for "Koala GraphAPI with an access token" do
   end
 
   it "can verify a message with an attachment posted to a feed" do
-    attachment = {"name" => "OAuth Playground", "link" => "http://oauth.twoalex.com/"}
+    attachment = {"name" => "OAuth Playground", "link" => "http://testdomain.koalatest.test/"}
     result = @api.put_wall_post("Hello, world, from the test suite again!", attachment)
     @temporary_object_id = result["id"]
     get_result = @api.get_object(@temporary_object_id)
@@ -508,7 +508,7 @@ shared_examples_for "Koala GraphAPI without an access token" do
   # but are here for completeness
   it "can't post to a feed" do
     expect(lambda do
-      attachment = {:name => "OAuth Playground", :link => "http://oauth.twoalex.com/"}
+      attachment = {:name => "OAuth Playground", :link => "http://testdomain.koalatest.test/"}
       @result = @api.put_wall_post("Hello, world", attachment, "facebook")
     end).to raise_error(Koala::Facebook::AuthenticationError)
   end

data/spec/support/mock_http_service.rb

@@ -8,7 +8,7 @@ module Koala
     # Mocks all HTTP requests for with koala_spec_with_mocks.rb
     # Mocked values to be included in TEST_DATA used in specs
     ACCESS_TOKEN = '*'
-    APP_ACCESS_TOKEN = "**"
+    APP_ACCESS_TOKEN = "********************"
     OAUTH_CODE = 'OAUTHCODE'
 
     # Loads testing data
@@ -30,7 +30,7 @@ module Koala
 
     # Loads the mock response data via ERB to substitue values for TEST_DATA (see oauth/access_token)
     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))
+    RESPONSES = YAML.safe_load(ERB.new(IO.read(mock_response_file_path)).result(binding), [], [], true)
 
     def self.make_request(request)
       if response = match_response(request.raw_path, request.raw_args, request.raw_verb, request.raw_options)

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta3
+  version: 3.1.0
 platform: ruby
 authors:
 - Alex Koppel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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
@@ -64,19 +78,16 @@ extra_rdoc_files:
 - readme.md
 - changelog.md
 files:
-- ".autotest"
+- ".github/workflows/test.yml"
 - ".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
@@ -135,7 +146,7 @@ homepage: http://github.com/arsduo/koala
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -150,46 +161,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.0.0
+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
-- spec/cases/multipart_request_spec.rb
-- spec/cases/oauth_spec.rb
-- spec/cases/realtime_updates_spec.rb
-- spec/cases/test_users_spec.rb
-- spec/cases/uploadable_io_spec.rb
-- spec/cases/utils_spec.rb
-- spec/fixtures/beach.jpg
-- 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
-- spec/support/custom_matchers.rb
-- spec/support/graph_api_shared_examples.rb
-- spec/support/koala_test.rb
-- spec/support/mock_http_service.rb
-- spec/support/uploadable_io_shared_examples.rb
-has_rdoc: 
+test_files: []

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/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-rvm:
-  # MRI
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - 2.4.0
-  # Rubinius is failing due to segfaults on Travis (and takes significantly longer to run)
-  # those builds will be restored later
-  # jruby
-  # - jruby-19mode
-bundler_args: --without development
-addons:
-  code_climate:
-    repo_token: 7af99d9225b4c14640f9ec3cb2e24d2f7103ac49417b0bd989188fb6c25f2909
-after_success:
-    - bundle exec codeclimate-test-reporter

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" }