koala 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f879bff1a0797804e8a89a2d8d34366ba21fafedd5317b4649326169dc9b7ed
-  data.tar.gz: 8f77e5f1d2f3eebcf5e08983ba4f2af69b64566d7d2d4dac6185a8b5c3222ba6
+  metadata.gz: dd1ef11b53dbfd2dc45d096a2b3f26d86aab74927758638b95670be82d5a81b3
+  data.tar.gz: 4f8694539f46568a268740064fa16f5f9084198f90ccdb2bf66b532d0fd280ae
 SHA512:
-  metadata.gz: 704dee302c62d906fd9f065abc86ea0e9268a4b160460ccfb455f8a7dbd3d41631bacf75e155953e5fd9d54e01fa81abc39f7730db4ea1023893b80dd378aa22
-  data.tar.gz: 38c9e731f1a76e3d441c3e783032a8f306168723e1552e00167dcd0bd5ad696833afffd2797ff4f4e0ed97e986578f08533b58f5064fa0610819fb409d10ddd3
+  metadata.gz: aa13fcdb702dacaf5ea61d905f1d4d09e067b8181c9bbe9f1e210d80718eb8015953b770fc79332658bf9a0c5b11e0923a31c85049fde4a5dc566367f5ed63a1
+  data.tar.gz: cda4d98559e43ce1cb2cfd4c308431020c32443282cf2161230f6cae81bfc7608494181f55cc15e8dfc4386b248a81ec7d2306125487a41b6d4c7c6f4bc84c09

data/.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, "3.0", 3.1, head]
+        ruby: [2.7, "3.0", 3.1, head]
 
     steps:
     - name: Checkout repository

data/Gemfile

@@ -10,6 +10,7 @@ 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
+  gem 'faraday-typhoeus' unless defined? JRUBY_VERSION
 end
 
 group :test do

data/changelog.md

@@ -15,6 +15,30 @@ Testing improvements:
 
 Others:
 
+v3.4.0 (2023-01-05)
+======
+
+Updated features:
+
+* Force use by default of HTTPS (instead of HTTP) when there is no access token.
+  HTTP can still be used by passing :use_ssl => false in the options hash for an api call ([#678](https://github.com/arsduo/koala/pull/678/files))
+
+v3.3.0 (2022-09-27)
+======
+
+Updated features:
+
+  * Removed restriction on faraday < 2 ([#666](https://github.com/arsduo/koala/pull/666))
+
+Internal improvements:
+
+ * Remove multipart hack and use default faraday multipart middleware ([#664](https://github.com/arsduo/koala/pull/664))
+
+Testing improvements:
+
+ * Fix tests with ruby-head ([#674](https://github.com/arsduo/koala/pull/674))
+ * Keep supported rubies (non EOL) for CI ([#675](https://github.com/arsduo/koala/pull/675))
+
 v3.2.0 (2022-05-27)
 ======
 

data/koala.gemspec

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

data/lib/koala/http_service/request.rb

@@ -106,9 +106,7 @@ module Koala
       end
 
       def add_ssl_options(opts)
-        # require https if there's a token
-        return opts unless raw_args["access_token"]
-
+        # require https by default (can be overriden by explicitly setting other SSL options)
         {
           use_ssl: true,
           ssl: {verify: true}.merge(opts[:ssl] || {})

data/lib/koala/http_service/uploadable_io.rb

@@ -1,4 +1,3 @@
-require "net/http/post/multipart"
 require "tempfile"
 
 module Koala

data/lib/koala/http_service.rb

@@ -1,5 +1,5 @@
 require 'faraday'
-require 'koala/http_service/multipart_request'
+require 'faraday/multipart' unless defined? Faraday::FilePart # hack for faraday < 1.9 to avoid warnings
 require 'koala/http_service/uploadable_io'
 require 'koala/http_service/response'
 require 'koala/http_service/request'
@@ -19,7 +19,7 @@ module Koala
     # We encode requests in a Facebook-compatible multipart request,
     # and use whichever adapter has been configured for this application.
     DEFAULT_MIDDLEWARE = Proc.new do |builder|
-      builder.use Koala::HTTPService::MultipartRequest
+      builder.request :multipart
       builder.request :url_encoded
       builder.adapter Faraday.default_adapter
     end

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "3.2.0"
+  VERSION = "3.4.0"
 end

data/spec/cases/api_spec.rb

@@ -345,7 +345,7 @@ describe "Koala::Facebook::API" do
       response = Koala::HTTPService::Response.new(200, result.to_json, { "x-ad-account-usage" => "{\"acc_id_util_pct\"9.67}"})
       allow(Koala).to receive(:make_request).and_return(response)
 
-      expect(Koala::Utils.logger).to receive(:error).with("JSON::ParserError: 859: unexpected token at '{\"acc_id_util_pct\"9.67}' while parsing x-ad-account-usage = {\"acc_id_util_pct\"9.67}")
+      expect(Koala::Utils.logger).to receive(:error).with(/JSON::ParserError:.*unexpected token at '{"acc_id_util_pct"9.67}' while parsing x-ad-account-usage = {"acc_id_util_pct"9.67}/)
       api.graph_call('anything')
     end
 

data/spec/cases/graph_error_checker_spec.rb

@@ -104,7 +104,7 @@ module Koala
               "x-app-usage" => '{invalid:json}'
             )
 
-            expect(Koala::Utils.logger).to receive(:error).with("JSON::ParserError: 859: unexpected token at '{invalid:json}' while parsing x-app-usage = {invalid:json}")
+            expect(Koala::Utils.logger).to receive(:error).with(/JSON::ParserError:.*unexpected token at '{invalid:json}' while parsing x-app-usage = {invalid:json}/)
             expect(error.fb_app_usage).to eq(nil)
           end
 

data/spec/cases/http_service/request_spec.rb

@@ -176,9 +176,9 @@ module Koala
         end
 
         describe "ssl options" do
-          it "does nothing if there's no access token" do
+          it "includes the default SSL options even if there's no access token" do
             request_options = Request.new(path: path, args: args.delete_if {|k, _v| k == "access_token"}, verb: verb, options: options).options
-            expect(request_options).not_to include(:ssl, :use_ssl)
+            expect(request_options).to include(use_ssl: true, ssl: {verify: true})
           end
 
           context "if there is an access_token" do
@@ -193,9 +193,9 @@ module Koala
             end
 
             it "overrides default SSL options with what's provided" do
-              new_ssl_options = {verify: :dunno}
-              request_options = Request.new(path: path, args: args, verb: verb, options: options.merge(ssl: new_ssl_options)).options
-              expect(request_options[:ssl]).to include(new_ssl_options)
+              new_ssl_options = {use_ssl: false, ssl:{verify: :dunno}}
+              request_options = Request.new(path: path, args: args, verb: verb, options: options.merge(new_ssl_options)).options
+              expect(request_options).to include(new_ssl_options)
             end
           end
         end
@@ -211,9 +211,17 @@ module Koala
               expect(request.server).to eq("https://foo")
             end
 
-            context "if options[:use_ssl] is false (e.g. no access token)" do
+            context "if there is no access token" do
               let(:args) { {"a" => "b"} }
 
+              it "uses https" do
+                expect(request.server).to eq("https://graph.facebook.com")
+              end
+            end
+
+            context "if options[:use_ssl] is false" do
+              let(:options) { {use_ssl: false} }
+
               it "uses http" do
                 expect(request.server).to eq("http://graph.facebook.com")
               end

data/spec/cases/http_service_spec.rb

@@ -39,8 +39,7 @@ describe Koala::HTTPService do
 
     it "adds the right default middleware" do
       Koala::HTTPService::DEFAULT_MIDDLEWARE.call(builder)
-      expect(builder.requests).to eq([:url_encoded])
-      expect(builder.uses).to eq([Koala::HTTPService::MultipartRequest])
+      expect(builder.requests).to eq([:multipart, :url_encoded])
       expect(builder.adapters).to eq([Faraday.default_adapter])
     end
   end
@@ -194,18 +193,16 @@ describe Koala::HTTPService do
 
     it "uses the default builder block if HTTPService.faraday_middleware block is not defined" do
       block = Proc.new { |builder|
-        builder.use Koala::HTTPService::MultipartRequest
+        builder.request :multipart
         builder.request :url_encoded
-        builder.use Koala::HTTPService::MultipartRequest
       }
       stub_const("Koala::HTTPService::DEFAULT_MIDDLEWARE", block)
       allow(Koala::HTTPService).to receive(:faraday_middleware).and_return(nil)
 
       expect_any_instance_of(Faraday::Connection).to receive(:get) do |instance|
         expect(instance.builder.handlers).to eq([
-          Koala::HTTPService::MultipartRequest,
+          Faraday::Multipart::Middleware,
           Faraday::Request::UrlEncoded,
-          Koala::HTTPService::MultipartRequest
         ])
         mock_http_response
       end
@@ -215,17 +212,15 @@ describe Koala::HTTPService do
 
     it "uses the defined HTTPService.faraday_middleware block if defined" do
       block = Proc.new { |builder|
-        builder.use Koala::HTTPService::MultipartRequest
+        builder.request :multipart
         builder.request :url_encoded
-        builder.use Koala::HTTPService::MultipartRequest
       }
       expect(Koala::HTTPService).to receive(:faraday_middleware).and_return(block)
 
       expect_any_instance_of(Faraday::Connection).to receive(:get) do |instance|
         expect(instance.builder.handlers).to eq([
-          Koala::HTTPService::MultipartRequest,
+          Faraday::Multipart::Middleware,
           Faraday::Request::UrlEncoded,
-          Koala::HTTPService::MultipartRequest
         ])
         mock_http_response
       end

data/spec/support/koala_test.rb

@@ -238,11 +238,11 @@ module KoalaTest
         # JRuby doesn't support typhoeus on Travis
         unless defined? JRUBY_VERSION
           require adapter
-          require 'typhoeus/adapters/faraday' if adapter.to_s == "typhoeus"
+          require "faraday/#{adapter}"
           Faraday.default_adapter = adapter.to_sym
         end
-      rescue ParserError
-        puts "Unable to load adapter #{adapter}, using Net::HTTP."
+      rescue => e
+        puts "Unable to load adapter #{adapter}, using Net::HTTP. #{e.class} #{e.message}"
       ensure
         @adapter_activation_attempted = true
       end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Alex Koppel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +115,6 @@ files:
 - 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
@@ -123,7 +136,6 @@ files:
 - 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
@@ -165,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A lightweight, flexible library for Facebook with support for the Graph API,

data/lib/koala/http_service/multipart_request.rb

@@ -1,37 +0,0 @@
-require 'faraday'
-
-module Koala
-  module HTTPService
-    class MultipartRequest < Faraday::Request::Multipart
-      # Facebook expects nested parameters to be passed in a certain way
-      # Based on our testing (https://github.com/arsduo/koala/issues/125),
-      # Faraday needs two changes to make that work:
-      # 1) [] need to be escaped (e.g. params[foo]=bar ==> params%5Bfoo%5D=bar)
-      # 2) such messages need to be multipart-encoded
-
-      self.mime_type = 'multipart/form-data'.freeze
-
-      def process_request?(env)
-        # if the request values contain any hashes or arrays, multipart it
-        super || !!(env[:body].respond_to?(:values) && env[:body].values.find {|v| v.is_a?(Hash) || v.is_a?(Array)})
-      end
-
-
-      def process_params(params, prefix = nil, pieces = nil, &block)
-        params.inject(pieces || []) do |all, (key, value)|
-          key = "#{prefix}%5B#{key}%5D" if prefix
-
-          case value
-          when Array
-            values = value.inject([]) { |a,v| a << [nil, v] }
-            process_params(values, key, all, &block)
-          when Hash
-            process_params(value, key, all, &block)
-          else
-            all << block.call(key, value)
-          end
-        end
-      end
-    end
-  end
-end

data/spec/cases/multipart_request_spec.rb

@@ -1,65 +0,0 @@
-require 'spec_helper'
-
-describe Koala::HTTPService::MultipartRequest do
-  it "is a subclass of Faraday::Request::Multipart" do
-    expect(Koala::HTTPService::MultipartRequest.superclass).to eq(Faraday::Request::Multipart)
-  end
-
-  it "defines mime_type as multipart/form-data" do
-    expect(Koala::HTTPService::MultipartRequest.mime_type).to eq('multipart/form-data')
-  end
-
-  describe "#process_request?" do
-    before :each do
-      @env = Faraday::Env.new
-      @multipart = Koala::HTTPService::MultipartRequest.new
-      allow(@multipart).to receive(:request_type).and_return("")
-    end
-
-    # no way to test the call to super, unfortunately
-    it "returns true if env[:body] is a hash with at least one hash in its values" do
-      @env[:body] = {:a => {:c => 2}}
-      expect(@multipart.process_request?(@env)).to be_truthy
-    end
-
-    it "returns true if env[:body] is a hash with at least one array in its values" do
-      @env[:body] = {:a => [:c, 2]}
-      expect(@multipart.process_request?(@env)).to be_truthy
-    end
-
-    it "returns true if env[:body] is a hash with mixed objects in its values" do
-      @env[:body] = {:a => [:c, 2], :b => {:e => :f}}
-      expect(@multipart.process_request?(@env)).to be_truthy
-    end
-
-    it "returns false if env[:body] is a string" do
-      @env[:body] = "my body"
-      expect(@multipart.process_request?(@env)).to be_falsey
-    end
-
-    it "returns false if env[:body] is a hash without an array or hash value" do
-      @env[:body] = {:a => 3}
-      expect(@multipart.process_request?(@env)).to be_falsey
-    end
-  end
-
-  describe "#process_params" do
-    before :each do
-      @parent = Faraday::Request::Multipart.new
-      @multipart = Koala::HTTPService::MultipartRequest.new
-      @block = lambda {|k, v| "#{k}=#{v}"}
-    end
-
-    it "is identical to the parent for requests without a prefix" do
-      hash = {:a => 2, :c => "3"}
-      expect(@multipart.process_params(hash, &@block)).to eq(@parent.process_params(hash, &@block))
-    end
-
-    it "replaces encodes [ and ] if the request has a prefix" do
-      hash = {:a => 2, :c => "3"}
-      prefix = "foo"
-      # process_params returns an array
-      expect(@multipart.process_params(hash, prefix, &@block).join("&")).to eq(@parent.process_params(hash, prefix, &@block).join("&").gsub(/\[/, "%5B").gsub(/\]/, "%5D"))
-    end
-  end
-end