ruby-trello 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36f88684585632f2f1fc785ea06cd651b6ba61105c1326e49cc9e4cbf1f5080
-  data.tar.gz: 1aeafd0ed644ac395d71ea296feac980ebd013f1b915c1caa99845c86c24d2b3
+  metadata.gz: 46d6d62edf1eb8973cfea687f157402b32ab4741b4f5cf3c638dd3b2704d5ad8
+  data.tar.gz: a31459e8d18d04b759be5ec6385b9fa75e55250fb691b37c484a639a799f8ee6
 SHA512:
-  metadata.gz: 4305a964e59f049220842e64dbd9df87dc4f94ff3a43825700178d2efeeae069dd607f718c6d1e027556921b20b6a2e187e92076d5debd85e314c916a61c5845
-  data.tar.gz: ba6056ba114bfb48cae07fad2acc4742641c3ef9c0adecdfbf0ee7f6aa4e6e08375ebbff6978918e4f1979c9a2b6ed33d29c1a846b6e89446b848e0cfb84576d
+  metadata.gz: ca3cffbb4c3e0b3ce88ec21dade8b5a21bf0b2bedb2cdb259523fac0986632d521eb04f3c607273192cd4ce617b73005152507dedfa42c370b51cf75e4d1ec45
+  data.tar.gz: 7b13d2e420d26fde4cdd62e09f7f199dd170102272f17c630554c2156aaee2ddc2f2f76a62a67707df23d252ce2723edd5de1b6697b64ca7ef2b9f30c6f56c15

data/README.md

@@ -87,7 +87,19 @@ end
 
 All the calls this library makes to Trello require authentication using these keys. Be sure to protect them.
 
-#### Usage
+#### HTTP Client
+
+By default, ruby-trello uses [rest-client](https://rubygems.org/gems/rest-client) for network calls. You can configure ruby-trello to use either rest-client or [faraday](https://rubygems.org/gems/faraday), depending on your project's needs. In the next major version, ruby-trello will not require either gem in the gemspec and will default to faraday if both are present.
+
+```ruby
+Trello.configure do |config|
+  config.http_client = 'rest-client'
+  # OR
+  config.http_client = 'faraday'
+end
+```
+
+## Usage
 
 So let's say you want to get information about the user *bobtester*. We can do something like this:
 
@@ -103,7 +115,7 @@ puts bob.bio # A wonderfully delightful test user
 # How about a list of his boards?
 bob.boards
 
-# And then to read the lists of the first board do : 
+# And then to read the lists of the first board do :
 bob.boards.first.lists
 ```
 
@@ -130,10 +142,10 @@ pp Trello::Card.find( card_id ).checklists
 
 ##### Changing a checkbox state
 ```ruby
-# First get your checklist id 
+# First get your checklist id
 checklist = Trello::Checklist.find( checklist_id )
 
-# At this point, there is no more ids. To get your checklist item, 
+# At this point, there is no more ids. To get your checklist item,
 # you have to know it's position (same as in the trello interface).
 # Let's take the first
 checklist_item = checklist.items.first

data/lib/trello/client.rb

@@ -99,7 +99,7 @@ module Trello
         raise Error.new(response.body, response.code)
       end
 
-      response.body
+      response
     end
 
     def auth_policy_class

data/lib/trello/configuration.rb

@@ -44,6 +44,14 @@ module Trello
       developer_public_key && member_token
     end
 
+    def http_client=(http_client)
+      Trello.http_client = http_client.to_s
+    end
+
+    def http_client
+      Trello::HTTP_CLIENTS.find { |k, v| v == Trello.http_client }[0]
+    end
+
     private
 
     def oauth_credentials

data/lib/trello/json_utils.rb

@@ -32,8 +32,8 @@ module Trello
       #   thing.a == 42
       #   thing.b == "foo"
       #
-      def from_response(data, encoding = 'UTF-8')
-        from_json(parse_json(data, encoding))
+      def from_response(response, encoding = 'UTF-8')
+        from_json(parse_json(response, encoding))
       end
 
       def from_json(json)
@@ -47,8 +47,14 @@ module Trello
         end
       end
 
-      def parse_json(string, encoding = 'UTF-8')
-        JSON.parse(string.force_encoding(encoding))
+      def parse_json(data, encoding = 'UTF-8')
+        # Trello.http_client.parse_json(data, encoding)
+        case data
+        when Trello::Response
+          JSON.parse(data.body.force_encoding(encoding))
+        else
+          JSON.parse(data.force_encoding(encoding))
+        end
       rescue JSON::ParserError => json_error
         if json_error.message =~ /model not found/
           Trello.logger.error "Could not find that record."

data/lib/trello/net/faraday.rb

@@ -0,0 +1,46 @@
+module Trello
+  module TFaraday
+    class TInternet
+      class << self
+        begin
+          require 'faraday'
+        rescue LoadError
+        end
+
+        def execute(request)
+          try_execute request
+        end
+
+        private
+
+        def try_execute(request)
+          begin
+            if request
+              result = execute_core request
+              Response.new(200, {}, result.body)
+            end
+          rescue Faraday::Error => e
+            raise if !e.respond_to?(:response) || e.response.nil? || e.response[:status].nil?
+            Response.new(e.response[:status], {}, e.response[:body])
+          end
+        end
+
+        def execute_core(request)
+          conn = Faraday.new(
+            request.uri.to_s,
+            headers: request.headers,
+            proxy: ENV['HTTP_PROXY'],
+            request: { timeout: 10 }
+          ) do |faraday|
+            faraday.response :raise_error
+            faraday.request :json
+          end
+
+          conn.send(request.verb) do |req|
+            req.body = request.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/net/rest_client.rb

@@ -0,0 +1,41 @@
+module Trello
+  module TRestClient
+    class TInternet
+      class << self
+        begin
+          require 'rest-client'
+        rescue LoadError
+        end
+
+        def execute(request)
+          try_execute request
+        end
+
+        private
+
+        def try_execute(request)
+          begin
+            if request
+              result = execute_core request
+              Response.new(200, {}, result.body)
+            end
+          rescue RestClient::Exception => e
+            raise if !e.respond_to?(:http_code) || e.http_code.nil?
+            Response.new(e.http_code, {}, e.http_body)
+          end
+        end
+
+        def execute_core(request)
+          RestClient.proxy = ENV['HTTP_PROXY'] if ENV['HTTP_PROXY']
+          RestClient::Request.execute(
+            method: request.verb,
+            url: request.uri.to_s,
+            headers: request.headers,
+            payload: request.body,
+            timeout: 10
+          )
+        end
+      end
+    end
+  end
+end

data/lib/trello/net.rb

@@ -4,35 +4,8 @@ module Trello
 
   class TInternet
     class << self
-      require "rest_client"
-
       def execute(request)
-        try_execute request
-      end
-
-      private
-
-      def try_execute(request)
-        begin
-          if request
-            result = execute_core request
-            Response.new(200, {}, result)
-          end
-        rescue RestClient::Exception => e
-          raise if !e.respond_to?(:http_code) || e.http_code.nil?
-          Response.new(e.http_code, {}, e.http_body)
-        end
-      end
-
-      def execute_core(request)
-        RestClient.proxy = ENV['HTTP_PROXY'] if ENV['HTTP_PROXY']
-        RestClient::Request.execute(
-          method: request.verb,
-          url: request.uri.to_s,
-          headers: request.headers,
-          payload: request.body,
-          timeout: 10
-        )
+        Trello.http_client.execute(request)
       end
     end
   end

data/lib/trello.rb

@@ -72,6 +72,7 @@ module Trello
   autoload :Organization,         'trello/organization'
   autoload :PluginDatum,          'trello/plugin_datum'
   autoload :Request,              'trello/net'
+  autoload :Response,             'trello/net'
   autoload :TInternet,            'trello/net'
   autoload :Token,                'trello/token'
   autoload :Webhook,              'trello/webhook'
@@ -79,6 +80,14 @@ module Trello
   autoload :AssociationInferTool, 'trello/association_infer_tool'
   autoload :Schema,               'trello/schema'
 
+  module TFaraday
+    autoload :TInternet,          'trello/net/faraday'
+  end
+
+  module TRestClient
+    autoload :TInternet,          'trello/net/rest_client'
+  end
+
   module Authorization
     autoload :AuthPolicy,         'trello/authorization'
     autoload :BasicAuthPolicy,    'trello/authorization'
@@ -112,6 +121,45 @@ module Trello
     @logger = logger
   end
 
+  # The order in which we will try the http clients
+  HTTP_CLIENT_PRIORITY = %w(rest-client faraday)
+  HTTP_CLIENTS = {
+    'faraday' => Trello::TFaraday::TInternet,
+    'rest-client' => Trello::TRestClient::TInternet
+  }
+
+  def self.http_client
+    @http_client ||= begin
+      # No client has been set explicitly. Try to load each supported client.
+      # The first one that loads successfully will be used.
+      client = HTTP_CLIENT_PRIORITY.each do |key|
+        begin
+          require key
+          break HTTP_CLIENTS[key]
+        rescue LoadError
+          next
+        end
+      end
+
+      raise ConfigurationError, 'Trello requires either rest-client or faraday installed' unless client
+
+      client
+    end
+  end
+
+  def self.http_client=(http_client)
+    if HTTP_CLIENTS.include?(http_client)
+      begin
+        require http_client
+        @http_client = HTTP_CLIENTS[http_client]
+      rescue LoadError
+        raise ConfigurationError, "Trello tried to use #{http_client}, but that gem is not installed"
+      end
+    else
+      raise ArgumentError, "Unsupported HTTP client: #{http_client}"
+    end
+  end
+
   def self.client
     @client ||= Client.new
   end
@@ -123,6 +171,7 @@ module Trello
 
   def self.reset!
     @client = nil
+    @http_client = nil
   end
 
   def self.auth_policy; client.auth_policy; end

data/spec/client_spec.rb

@@ -1,4 +1,6 @@
 require "spec_helper"
+require "rest-client"
+require "faraday"
 
 include Trello
 include Trello::Authorization
@@ -18,11 +20,16 @@ describe Client do
   end
 
   describe "and how it handles RestClient exceptions" do
+
+    before do
+      Trello.http_client = 'rest-client'
+    end
+
     context "with RestClient::Exception sans HTTP code" do
       let(:rc_exception_without_http_code) { RestClient::Exception.new }
 
       before do
-        allow(TInternet)
+        allow(Trello::TRestClient::TInternet)
           .to receive(:execute_core)
           .and_raise(rc_exception_without_http_code)
       end
@@ -39,14 +46,61 @@ describe Client do
       let(:rc_exception_with_http_code) { RestClient::Exception.new(double("404 error response", {:code => 404, :body => "404 error response"}))}
 
       before do
-        allow(TInternet)
+        allow(Trello::TRestClient::TInternet)
           .to receive(:execute_core)
           .and_raise(rc_exception_with_http_code)
       end
 
       it "raises Error" do
 
-        expect(TInternet)
+        expect(Trello::TRestClient::TInternet)
+          .to receive(:try_execute)
+          .and_return(response_with_non_200_status)
+
+        expect { client.get "/xxx" }.to raise_error do |error|
+          expect(error).to be_a(Error)
+          expect(error.message).to eq("404 error response")
+          expect(error.status_code).to eq(404)
+        end
+      end
+    end
+  end
+
+  describe "and how it handles Faraday errors" do
+
+    before do
+      Trello.http_client = 'faraday'
+    end
+
+    context "with Faraday::Error sans HTTP code" do
+      let(:faraday_error_without_http_code) { Faraday::Error.new("Test error") }
+
+      before do
+        allow(Trello::TFaraday::TInternet)
+          .to receive(:execute_core)
+          .and_raise(faraday_error_without_http_code)
+      end
+
+      it "bubbles up Faraday::Error errors that don't contain an HTTP code" do
+        expect { client.get "/xxx" }.to raise_error faraday_error_without_http_code
+      end
+    end
+
+    context "with Faraday::Error that contains HTTP code" do
+      let(:response_with_non_200_status) { double "A fake 404 response",
+                                              code: 404,
+                                              body: "404 error response"}
+      let(:faraday_error_with_http_code) { Faraday::Error.new(double("404 error response", {:code => 404, :body => "404 error response"}))}
+
+      before do
+        allow(Trello::TFaraday::TInternet)
+          .to receive(:execute_core)
+          .and_raise(faraday_error_with_http_code)
+      end
+
+      it "raises Error" do
+
+        expect(Trello::TFaraday::TInternet)
           .to receive(:try_execute)
           .and_return(response_with_non_200_status)
 

data/spec/configuration_spec.rb

@@ -19,6 +19,19 @@ describe Trello::Configuration do
     end
   end
 
+  it "only allows http_client to be set to one of Trello::HTTP_CLIENTS" do
+    Trello::HTTP_CLIENTS.each do |key, _client|
+      configuration.http_client = key
+      expect(configuration.http_client).to eq key
+    end
+  end
+
+  it "raises an error if an invalid http_client is set" do
+    expect {
+      configuration.http_client = :invalid_http_client
+    }.to raise_error(ArgumentError)
+  end
+
   it 'has a callback (for oauth)' do
     callback = -> { 'foobar' }
     configuration.callback = callback

data/spec/integration/board/add_member_spec.rb

@@ -14,8 +14,7 @@ RSpec.describe 'Trello::Board#add_member' do
       expect(response.code).to eq(200)
       body = JSON.parse(response.body)
       expect(body['id']).to eq('5e93ba98614ac22d22f085c4')
-      expect(body['members'][0]['username']).to eq('wokenqingtian') 
+      expect(body['members'][0]['username']).to eq('wokenqingtian')
     end
   end
-
 end

data/spec/integration/card/delete_spec.rb

@@ -8,8 +8,8 @@ RSpec.describe 'Trello::Card#delete' do
   it 'can success delete card' do
     VCR.use_cassette('can_success_delete_card') do
       card = Trello::Card.find('5e95b664ace3621af695aeb0')
-      respone = card.delete
-      expect(respone.code).to eq(200)
+      response = card.delete
+      expect(response.code).to eq(200)
     end
   end
 

data/spec/integration/integration_test.rb

@@ -25,16 +25,16 @@ module IntegrationTest
         @welcome_board        = ENV["WELCOME_BOARD"]
         @access_token_key     = ENV["ACCESS_TOKEN_KEY"]
         @access_token_secret  = ENV["ACCESS_TOKEN_SECRET"]
-        
+
         WebMock.disable!
-      end    
+      end
     end
   end
 
   protected
 
   def get(uri)
-    require "rest_client"
+    require "rest-client"
     RestClient.get uri.to_s
   end
 end

data/spec/spec_helper.rb

@@ -59,6 +59,14 @@ RSpec.configure do |rspec|
   rspec.color = true
 end
 
+Trello::HTTP_CLIENTS.each do |key, _client|
+  RSpec.shared_context "using #{key}" do
+    before do
+      Trello.http_client = key
+    end
+  end
+end
+
 RSpec::Expectations.configuration.on_potential_false_positives = :nothing
 
 module IntegrationHelpers
@@ -66,6 +74,7 @@ module IntegrationHelpers
     Trello.configure do |config|
       config.developer_public_key = ENV['TRELLO_DEVELOPER_PUBLIC_KEY'] || 'developerpublickey'
       config.member_token = ENV['TRELLO_MEMBER_TOKEN'] || 'membertoken'
+      config.http_client = ENV['HTTP_CLIENT_GEM'] || 'rest-client'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-trello
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Jeremy Tregunna
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -128,6 +128,8 @@ files:
 - lib/trello/member.rb
 - lib/trello/multi_association.rb
 - lib/trello/net.rb
+- lib/trello/net/faraday.rb
+- lib/trello/net/rest_client.rb
 - lib/trello/notification.rb
 - lib/trello/organization.rb
 - lib/trello/plugin_datum.rb