koala 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6941f9efa1f2d1a275581f20b5d10977f3d73fdd
-  data.tar.gz: 726f62799f0c20c9266515dc6d68bc333e9995d0
+SHA256:
+  metadata.gz: 3209d60dbf8ab51fac40f7b990f221076bb453329641194dce55b800d0611856
+  data.tar.gz: 9dfb75f13c1b1e187c325453793b6dfcdc085a0f42e119d40df7a30d7b492250
 SHA512:
-  metadata.gz: 10d6e349ebe3e89487f9052840d12d27b52b5fce77cb649fb97e2554855bf39c12acf60da93c3c5e55bf2f0ea66b9533310c50cad23006da331b4e253dfa4e77
-  data.tar.gz: 67c74e5c4af1c273d4c1e7edae915897753b610357763bf398b8c8b6107853dbbdaf86ac174951e2efddadd9aa5a611cb343c0655388e7a75b407ba80823a1c4
+  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/changelog.md

@@ -1,3 +1,41 @@
+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)
 ======
 

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", ">= 1.8")
+  gem.add_runtime_dependency("rexml")
 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/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "3.0.0"
+  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:

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/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/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
+  version: 3.1.0
 platform: ruby
 authors:
 - Alex Koppel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-17 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
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         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,9 +78,9 @@ extra_rdoc_files:
 - readme.md
 - changelog.md
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - ISSUE_TEMPLATE
@@ -132,7 +146,7 @@ homepage: http://github.com/arsduo/koala
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -151,42 +165,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       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/.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