ruby-trello 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444768a08c6a6d45235a6a35d935870d9a18dfd3486e64067ba4cdececf34701
-  data.tar.gz: b3af839b451f934e29be6c6a5247c2945fc6d864182f70dc70be284f38c9cb55
+  metadata.gz: b0b194ee4ee89c070fb0114b73ce3284368c98f5053555e1a3840a23f8d478b7
+  data.tar.gz: 8d1f2ccee4d1e694d8d49b7428ad5e2e0d4a4cdacf713c7edbd86f7782bb07fb
 SHA512:
-  metadata.gz: 5a719ac68ef702c5acb8e1cdccee07ff149f69c73e523f5c553823f68d3a7ac9643337b668218009f3c45138d69545dcde89946bad1b5f3fe464ea1ae6b0f020
-  data.tar.gz: 6a3f2dd5aee11df5ab30a08098174c70119e1ceac944d4b689e0fca4076d9dac198d06b63f376c8142fd4a825ac96645e34eacca260f1909257b2b7cfaf340b6
+  metadata.gz: afb77d7aafa9cee6c727997864b9d009ae31d679a8e5ae1d5d4c2699b61dd27f99f21a1a13196ad3003c4222b926e4b4822dc11cedd1997bf52ae2e35e2ff474
+  data.tar.gz: '039ec7a24b9efa6445138ad0fb7072cb5acfdfc40edf7e9bc383959e3bdcf8ca30e80efee66be088a15008b2456e53b663cfab4666eecce79c3243356d468db4'

data/lib/trello/card.rb

@@ -273,7 +273,7 @@ module Trello
       # Is it a file object or a string (url)?
       if attachment.respond_to?(:path) && attachment.respond_to?(:read)
         client.post("/cards/#{id}/attachments", {
-            file: attachment,
+            file: Trello::TInternet.multipart_file(attachment),
             name: name
           })
       else

data/lib/trello/net/faraday.rb

@@ -4,6 +4,8 @@ module Trello
       class << self
         begin
           require 'faraday'
+          require 'faraday/multipart'
+          require 'mime/types'
         rescue LoadError
         end
 
@@ -11,6 +13,14 @@ module Trello
           try_execute request
         end
 
+        def multipart_file(file)
+          Faraday::Multipart::FilePart.new(
+            file,
+            content_type(file),
+            filename(file)
+          )
+        end
+
         private
 
         def try_execute(request)
@@ -33,6 +43,7 @@ module Trello
             request: { timeout: 10 }
           ) do |faraday|
             faraday.response :raise_error
+            faraday.request :multipart
             faraday.request :json
           end
 
@@ -40,6 +51,26 @@ module Trello
             req.body = request.body
           end
         end
+
+        def content_type(file)
+          return file.content_type if file.respond_to?(:content_type)
+
+          mime = MIME::Types.type_for file.path
+          if mime.empty?
+            'text/plain'
+          else
+            mime[0].content_type
+          end
+        end
+
+        def filename(file)
+          if file.respond_to?(:original_filename)
+            file.original_filename
+          else
+            File.basename(file.path)
+          end
+        end
+
       end
     end
   end

data/lib/trello/net/rest_client.rb

@@ -11,6 +11,10 @@ module Trello
           try_execute request
         end
 
+        def multipart_file(file)
+          file
+        end
+
         private
 
         def try_execute(request)

data/lib/trello/net.rb

@@ -7,6 +7,10 @@ module Trello
       def execute(request)
         Trello.http_client.execute(request)
       end
+
+      def multipart_file(file)
+        Trello.http_client.multipart_file(file)
+      end
     end
   end
 end

data/spec/card_spec.rb

@@ -734,7 +734,7 @@ module Trello
 
         allow(client)
           .to receive(:post)
-          .with("/cards/abcdef123456789123456789/attachments", { file: f, name: ''  })
+          .with("/cards/abcdef123456789123456789/attachments", { file: instance_of(Multipart::Post::UploadIO), name: ''  })
           .and_return "not important"
 
         card.add_attachment(f)

data/spec/cassettes/can_add_a_file_on_a_card_with_farady.yml

@@ -0,0 +1,244 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.trello.com/1/cards/5e95d1b4f43f9a06497f17f7?key=DEVELOPER_PUBLIC_KEY&token=MEMBER_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.3.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 11 Nov 2023 18:18:11 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '1053'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - DENY
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Surrogate-Control:
+      - no-store
+      Cache-Control:
+      - max-age=0, must-revalidate, no-cache, no-store
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00
+      X-Trello-Version:
+      - 1.242759.0
+      X-Trello-Environment:
+      - Production
+      Set-Cookie:
+      - dsc=set_cookie_dsc; Path=/; Expires=Sat, 25 Nov 2023 18:18:11 GMT; Secure;
+        SameSite=None
+      - preAuthProps=s%3A5e679b808e6e8828784b30e1%3AisEnterpriseAdmin%3Dfalse.Pfv1AFghhSOM0MLjFpWB8CaOPcNRIjt%2FmCZysEK4KNY;
+        Path=/; HttpOnly
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Headers:
+      - Authorization, Accept, Content-Type
+      Access-Control-Expose-Headers:
+      - x-rate-limit-api-key-interval-ms, x-rate-limit-api-key-max, x-rate-limit-api-key-remaining,
+        x-rate-limit-api-token-interval-ms, x-rate-limit-api-token-max, x-rate-limit-api-token-remaining
+      X-Rate-Limit-Api-Token-Interval-Ms:
+      - '10000'
+      X-Rate-Limit-Api-Token-Max:
+      - '100'
+      X-Rate-Limit-Api-Token-Remaining:
+      - '99'
+      X-Rate-Limit-Db-Query-Time-Interval-Ms:
+      - '600000'
+      X-Rate-Limit-Db-Query-Time-Max:
+      - '7200000'
+      X-Rate-Limit-Db-Query-Time-Remaining:
+      - '7199990'
+      X-Rate-Limit-Api-Key-Interval-Ms:
+      - '10000'
+      X-Rate-Limit-Api-Key-Max:
+      - '300'
+      X-Rate-Limit-Api-Key-Remaining:
+      - '299'
+      X-Rate-Limit-Member-Interval-Ms:
+      - '10000'
+      X-Rate-Limit-Member-Max:
+      - '375'
+      X-Rate-Limit-Member-Remaining:
+      - '374'
+      X-Server-Time:
+      - '1699726691750'
+      Server:
+      - AtlassianEdge
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Atl-Traceid:
+      - 5442e51c04ce42f5aa01bfb53445cc31
+      Report-To:
+      - '{"endpoints": [{"url": "https://dz8aopenkvv6s.cloudfront.net"}], "group":
+        "endpoint-1", "include_subdomains": true, "max_age": 600}'
+      Nel:
+      - '{"failure_fraction": 0.001, "include_subdomains": true, "max_age": 600, "report_to":
+        "endpoint-1"}'
+      Strict-Transport-Security:
+      - max-age=63072000; preload
+    body:
+      encoding: UTF-8
+      string: '{"id":"5e95d1b4f43f9a06497f17f7","badges":{"attachmentsByType":{"trello":{"board":0,"card":0}},"location":false,"votes":0,"viewingMemberVoted":false,"subscribed":false,"start":null,"fogbugz":"","checkItems":0,"checkItemsChecked":0,"checkItemsEarliestDue":null,"comments":0,"attachments":3,"description":false,"due":null,"dueComplete":false},"checkItemStates":[],"closed":false,"dueComplete":false,"dateLastActivity":"2023-11-11T18:14:08.574Z","desc":"","descData":null,"due":null,"dueReminder":null,"email":null,"idBoard":"5e94f5ded016b22c2437c13c","idChecklists":[],"idList":"5e95d1b07f2ff83927319128","idMembers":[],"idMembersVoted":[],"idShort":2,"idAttachmentCover":"","labels":[],"idLabels":[],"manualCoverAttachment":false,"name":"C2","pos":16384,"shortLink":"DeJYDbq0","shortUrl":"https://trello.com/c/DeJYDbq0","start":null,"subscribed":false,"url":"https://trello.com/c/DeJYDbq0/2-c2","cover":{"idAttachment":null,"color":null,"idUploadedBackground":null,"size":"normal","brightness":"light","idPlugin":null},"isTemplate":false,"cardRole":null}'
+  recorded_at: Sat, 11 Nov 2023 18:18:11 GMT
+- request:
+    method: post
+    uri: https://api.trello.com/1/cards/5e95d1b4f43f9a06497f17f7/attachments?key=DEVELOPER_PUBLIC_KEY&token=MEMBER_TOKEN
+    body:
+      encoding: UTF-8
+      string: "-------------RubyMultipartPost-045b3ab4e226f744d8d7119fa63ad0fb\r\nContent-Disposition:
+        form-data; name=\"file\"; filename=\"add_and_remove_attachment_spec.rb\"\r\nContent-Length:
+        1672\r\nContent-Type: application/x-ruby\r\nContent-Transfer-Encoding: binary\r\n\r\nrequire
+        'spec_helper'\n\nRSpec.describe 'Trell::Card add and remove attachment' do\n
+        \ include IntegrationHelpers\n\n  before { setup_trello }\n\n  describe '#add_attachment'
+        do\n    it 'can success add an attachment(file) on a card', focus: true do\n
+        \     cassette_name = Trello.http_client == \"rest-client\" ? \"can_add_a_file_on_a_card\"
+        : \"can_add_a_file_on_a_card_with_farady\"\n      VCR.use_cassette(cassette_name)
+        do\n        card = Trello::Card.find('5e95d1b4f43f9a06497f17f7')\n        file
+        = File.new('spec/integration/card/add_and_remove_attachment_spec.rb', 'r')\n\n
+        \       response = card.add_attachment(file)\n        expect(response.code).to
+        eq(200)\n        body = JSON.parse(response.body)\n        expect(body['name']).to
+        eq('add_and_remove_attachment_spec.rb')\n      end\n    end\n\n    it 'can
+        success add and attachment(url) on a card' do\n      VCR.use_cassette('can_add_a_file_from_url_on_a_card')
+        do\n        card = Trello::Card.find('5e95d1b4f43f9a06497f17f7')\n        file_url
+        = 'https://upload.wikimedia.org/wikipedia/en/6/6b/Hello_Web_Series_%28Wordmark%29_Logo.png'\n\n
+        \       response = card.add_attachment(file_url, 'hello.png')\n        expect(response.code).to
+        eq(200)\n        body = JSON.parse(response.body)\n        expect(body['name']).to
+        eq('hello.png')\n      end\n    end\n  end\n\n  describe '#remove_attachment'
+        do\n    it 'can success remove and attachment on a card' do\n      VCR.use_cassette('can_remove_an_attachment_on_a_card')
+        do\n        card = Trello::Card.find('5e95d1b4f43f9a06497f17f7')\n        attachments
+        = card.attachments\n\n        response = card.remove_attachment(attachments.last)\n
+        \       expect(response.code).to eq(200)\n      end\n    end\n  end\nend\n\r\n-------------RubyMultipartPost-045b3ab4e226f744d8d7119fa63ad0fb\r\nContent-Disposition:
+        form-data; name=\"name\"\r\n\r\n\r\n-------------RubyMultipartPost-045b3ab4e226f744d8d7119fa63ad0fb--\r\n"
+    headers:
+      User-Agent:
+      - Faraday v2.3.0
+      Content-Type:
+      - multipart/form-data; boundary=-----------RubyMultipartPost-045b3ab4e226f744d8d7119fa63ad0fb
+      Content-Length:
+      - '2104'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 11 Nov 2023 18:18:14 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '451'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - DENY
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Surrogate-Control:
+      - no-store
+      Cache-Control:
+      - max-age=0, must-revalidate, no-cache, no-store
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00
+      X-Trello-Version:
+      - 1.242759.0
+      X-Trello-Environment:
+      - Production
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Headers:
+      - Authorization, Accept, Content-Type
+      Access-Control-Expose-Headers:
+      - x-rate-limit-api-key-interval-ms, x-rate-limit-api-key-max, x-rate-limit-api-key-remaining,
+        x-rate-limit-api-token-interval-ms, x-rate-limit-api-token-max, x-rate-limit-api-token-remaining
+      X-Rate-Limit-Api-Token-Interval-Ms:
+      - '10000'
+      X-Rate-Limit-Api-Token-Max:
+      - '100'
+      X-Rate-Limit-Api-Token-Remaining:
+      - '98'
+      X-Rate-Limit-Db-Query-Time-Interval-Ms:
+      - '600000'
+      X-Rate-Limit-Db-Query-Time-Max:
+      - '7200000'
+      X-Rate-Limit-Db-Query-Time-Remaining:
+      - '7199990'
+      X-Rate-Limit-Api-Key-Interval-Ms:
+      - '10000'
+      X-Rate-Limit-Api-Key-Max:
+      - '300'
+      X-Rate-Limit-Api-Key-Remaining:
+      - '298'
+      X-Rate-Limit-Member-Interval-Ms:
+      - '10000'
+      X-Rate-Limit-Member-Max:
+      - '375'
+      X-Rate-Limit-Member-Remaining:
+      - '373'
+      Set-Cookie:
+      - preAuthProps=s%3A5e679b808e6e8828784b30e1%3AisEnterpriseAdmin%3Dfalse.Pfv1AFghhSOM0MLjFpWB8CaOPcNRIjt%2FmCZysEK4KNY;
+        Path=/; HttpOnly
+      X-Server-Time:
+      - '1699726694377'
+      Server:
+      - AtlassianEdge
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Atl-Traceid:
+      - c52c43e2b82d4915bb527fc58f3153bc
+      Report-To:
+      - '{"endpoints": [{"url": "https://dz8aopenkvv6s.cloudfront.net"}], "group":
+        "endpoint-1", "include_subdomains": true, "max_age": 600}'
+      Nel:
+      - '{"failure_fraction": 0.001, "include_subdomains": true, "max_age": 600, "report_to":
+        "endpoint-1"}'
+      Strict-Transport-Security:
+      - max-age=63072000; preload
+    body:
+      encoding: UTF-8
+      string: '{"id":"654fc566366a6de141e759d8","bytes":1672,"date":"2023-11-11T18:18:14.070Z","edgeColor":null,"idMember":"5e679b808e6e8828784b30e1","isUpload":true,"mimeType":"application/x-ruby","name":"add_and_remove_attachment_spec.rb","previews":[],"url":"https://trello.com/1/cards/5e95d1b4f43f9a06497f17f7/attachments/654fc566366a6de141e759d8/download/add_and_remove_attachment_spec.rb","pos":81920,"fileName":"add_and_remove_attachment_spec.rb","limits":{}}'
+  recorded_at: Sat, 11 Nov 2023 18:18:14 GMT
+recorded_with: VCR 6.1.0

data/spec/integration/card/add_and_remove_attachment_spec.rb

@@ -7,7 +7,8 @@ RSpec.describe 'Trell::Card add and remove attachment' do
 
   describe '#add_attachment' do
     it 'can success add an attachment(file) on a card' do
-      VCR.use_cassette('can_add_a_file_on_a_card') do
+      cassette_name = Trello.http_client == "rest-client" ? "can_add_a_file_on_a_card" : "can_add_a_file_on_a_card_with_farady"
+      VCR.use_cassette(cassette_name) do
         card = Trello::Card.find('5e95d1b4f43f9a06497f17f7')
         file = File.new('spec/integration/card/add_and_remove_attachment_spec.rb', 'r')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-trello
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Jeremy Tregunna
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-24 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -80,6 +80,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: A wrapper around the trello.com API.
 email: jeremy@tregunna.ca
 executables: []
@@ -158,6 +192,7 @@ files:
 - spec/cassettes/board_find_with_id_and_get_specific_fields.yml
 - spec/cassettes/can_add_a_file_from_url_on_a_card.yml
 - spec/cassettes/can_add_a_file_on_a_card.yml
+- spec/cassettes/can_add_a_file_on_a_card_with_farady.yml
 - spec/cassettes/can_add_a_member_to_a_board.yml
 - spec/cassettes/can_add_a_member_to_a_card.yml
 - spec/cassettes/can_add_label_on_a_card.yml
@@ -465,6 +500,7 @@ test_files:
 - spec/cassettes/board_find_with_id_and_get_specific_fields.yml
 - spec/cassettes/can_add_a_file_from_url_on_a_card.yml
 - spec/cassettes/can_add_a_file_on_a_card.yml
+- spec/cassettes/can_add_a_file_on_a_card_with_farady.yml
 - spec/cassettes/can_add_a_member_to_a_board.yml
 - spec/cassettes/can_add_a_member_to_a_card.yml
 - spec/cassettes/can_add_label_on_a_card.yml