wetransfer 0.4.4 → 0.9.0.beta

data/lib/we_transfer_client/version.rb

@@ -1,3 +1,3 @@
-class WeTransferClient
-  VERSION = '0.4.4'
+module WeTransfer
+  VERSION = '0.9.0.beta'
 end

data/spec/board_integration_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe WeTransfer::Client do
+  let(:small_file_name) { 'Japan-02.jpg' }
+  let(:big_file) { File.open(fixtures_dir + 'Japan-01.jpg', 'rb') }
+  let(:client) do
+    WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+  end
+
+  it 'creates a board with files and web items as a block' do
+    # Create a board with three items, one small file, one multipart file, and one web url
+    board = client.create_board_and_upload_items(name: 'Test Board', description: 'Test description') do |b|
+      b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+      b.add_file(name: 'big file', io: big_file)
+      b.add_file_at(path: fixtures_dir + small_file_name)
+      b.add_web_url(url: 'http://www.wetransfer.com', title: 'WeTransfer Website')
+    end
+
+    # the board url is set
+    expect(board.url =~ %r|https://we.tl/b-|).to be_truthy
+
+    expect(board.items.map(&:class)).to eq([RemoteFile, RemoteFile, RemoteFile, RemoteLink])
+    expect(board.items[1].multipart.part_numbers).to be > 1
+    expect(board.items.count).to be(4)
+
+    # TODO: make these experimental steps public
+    # # Add two new items to the board, one small file and one web url
+    # client.add_items(board: board) do |b|
+    #   b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+    #   b.add_web_url(url: 'http://www.google.com', title: 'google')
+    # end
+    # expect(board.items.count).to be(6)
+
+    # # Check if the board includes 3 File items and 2 Link items
+    # expect(board.items.select { |i| i.type == 'file' }.count).to be(4)
+    # expect(board.items.select { |i| i.type == 'link' }.count).to be(2)
+
+    # # Upload the Files to the Board
+    # file_items = board.items.select { |i| i.type == 'file' }
+    # client.upload_file(object: board, file: file_items[0], io: File.open(__FILE__, 'rb'))
+    # client.upload_file(object: board, file: file_items[1], io: big_file)
+    # client.upload_file(object: board, file: file_items[2], io: File.open(fixtures_dir + small_file_name, 'rb'))
+    # client.upload_file(object: board, file: file_items[3], io: File.open(__FILE__, 'rb'))
+
+    # # Complete all the files of the board
+    # file_items.each do |item|
+    #   client.complete_file!(object: board, file: item)
+    # end
+
+    # Do a get request to see if url is available
+    response = Faraday.get(board.url)
+
+    # that should redirect us...
+    expect(response.status).to eq(302)
+    # ... to a board in the wetransfer domain
+    expect(response['location']).to start_with('https://boards.wetransfer')
+
+    # Check for the Boards status to be downloadable
+    resulting_board = loop do
+      res = client.get_board(board: board)
+      break res if res.state != 'processing'
+      sleep 1
+    end
+
+    expect(resulting_board.state).to eq('downloadable')
+    expect(resulting_board.items.count).to be(4)
+  end
+end

data/spec/features/add_items_to_board_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe WeTransfer::Client::Boards do
+  let(:client) { WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY')) }
+  let(:board) do
+    client.create_board(name: 'Test Board', description: 'Test Descritpion')
+  end
+
+  describe '#add_items' do
+    before do
+      skip "this interface is still experimental"
+    end
+
+    it 'adds items to a board' do
+      client.add_items(board: board) do |b|
+        b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+        b.add_file_at(path: fixtures_dir + 'Japan-02.jpg')
+        b.add_web_url(url: 'http://www.google.com', title: 'google')
+      end
+    end
+
+    it 'fails when no block is given' do
+      expect {
+        client.add_items(board: board)
+      }.to raise_error ArgumentError, /No items/
+    end
+
+    it 'fails when no board is passed as keyword argument' do
+      expect {
+        client.add_items do |b|
+          b.add_file_at(path: fixtures_dir + 'Japan-01.jpg')
+        end
+      }.to raise_error ArgumentError, /board/
+    end
+
+    it 'fails when file is not found' do
+      expect {
+        client.add_items(board: board) do |b|
+          b.add_file(name: 'file_not_found.rb', io: File.open('/path/to/non-existent-file.rb', 'r'))
+        end
+      }.to raise_error Errno::ENOENT, /No such file/
+    end
+
+    it 'fails when board is not a existing remote board' do
+      new_board = RemoteBoard.new(id: 123456, state: 'proccessing', url: 'https://www.we.tl/123456', name: 'fake board')
+      expect {
+        client.add_items(board: new_board) do |b|
+          b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+          b.add_file_at(path: fixtures_dir + 'Japan-01.jpg')
+          b.add_web_url(url: 'http://www.google.com', title: 'google')
+        end
+      }.to raise_error WeTransfer::Client::Error, /404 code/
+    end
+  end
+end

data/spec/features/create_board_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe WeTransfer::Client::Boards do
+  let(:big_file) { File.open(fixtures_dir + 'Japan-01.jpg', 'r') }
+  let(:client) { WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY')) }
+
+  describe '#create_board' do
+    before {
+      skip "this interface is still experimental"
+    }
+
+    it 'creates a remote board' do
+      client.create_board(name: 'Test Board', description: 'Test Descritpion')
+    end
+
+    it 'creates a board with items' do
+      client.create_board(name: 'Test Board', description: 'Test descrition') do |b|
+        b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+        b.add_file(name: 'big file', io: big_file)
+        b.add_web_url(url: 'http://www.wetransfer.com', title: 'WeTransfer Website')
+      end
+    end
+
+    it 'fails when name is missing' do
+      expect {
+        client.create_board(name: '', description: 'Test Descritpion')
+      }.to raise_error WeTransfer::Client::Error, /400 code/
+    end
+
+    it 'fails when file path is wrong' do
+      expect {
+        client.create_board(name: 'Test Board', description: 'Test descrition') do |b|
+          b.add_file(name: 'file_not_found.rb', io: File.open('path/to/non-existing-file.rb', 'r'))
+        end
+      }.to raise_error Errno::ENOENT, /No such file/
+    end
+
+    it 'fails when file name is missing' do
+      expect {
+        client.create_board(name: 'Test Board', description: 'Test descrition') do |b|
+          b.add_file(name: '', io: File.open(__FILE__, 'rb'))
+        end
+      }.to raise_error WeTransfer::Client::Error, /400 code/
+    end
+  end
+end

data/spec/features/get_board_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe WeTransfer::Client::Boards do
+  let(:client) do
+    WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+  end
+
+  let(:board) do
+    client.create_board(name: 'Test Board', description: 'Test Descritpion')
+  end
+
+  describe '#get_board' do
+    before do
+      skip "this interface is still experimental"
+    end
+
+    it 'it gets a exisiting board' do
+      client.get_board(board: board)
+    end
+
+    it 'fails when no board is given' do
+      expect {
+        client.get_board
+      }.to raise_error ArgumentError, /board/
+    end
+
+    it 'fails when board doenst exists' do
+      new_board = RemoteBoard.new(id: 123456, state: 'proccessing', url: 'https://www.we.tl/123456', name: 'fake board')
+      expect {
+        client.get_board(board: new_board)
+      }.to raise_error WeTransfer::Client::Error, /404 code/
+    end
+  end
+end

data/spec/features/transfer_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe WeTransfer::Client::Transfers do
+  let(:client) do
+    WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
+  end
+
+  let(:file_location) { fixtures_dir + 'Japan-02.jpg' }
+
+  let(:created_transfer) do
+    client.create_transfer(message: 'Test transfer') do |builder|
+      builder.add_file(name: File.basename(file_location), io: File.open(file_location, 'rb'))
+    end
+  end
+
+  describe "#create_transfer" do
+    before do
+      skip "this interface is still experimental"
+    end
+
+    it "is needed to add a file" do
+      expect { client.create_transfer(message: "Transfer name") }
+        .to raise_error(ArgumentError, /^No files were added/)
+    end
+
+    it "accepts a block to add files by their location" do
+      client.create_transfer(message: 'Test transfer') do |builder|
+        builder.add_file_at(path: file_location)
+      end
+    end
+
+    it "accepts a block to add files by their io" do
+      client.create_transfer(message: 'Test transfer') do |builder|
+        builder.add_file(name: File.basename(file_location), io: File.open(file_location, 'rb'))
+      end
+    end
+  end
+
+  describe "#complete_transfer"
+  describe "#get_transfer"
+end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'simplecov'
+require 'securerandom'
+
 SimpleCov.start do
   add_filter '/spec/'
 end
@@ -12,8 +14,26 @@ require 'tempfile'
 require 'dotenv'
 Dotenv.load
 
+module SpecHelpers
+  def fixtures_dir
+    __dir__ + '/fixtures/'
+  end
+
+  def test_logger
+    Logger.new($stderr).tap { |log| log.level = Logger::WARN }
+  end
+end
+
 RSpec.configure do |config|
+  config.include SpecHelpers
+  config.extend SpecHelpers
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.default_formatter = 'doc'
+  config.order = :random
 end

data/spec/transfer_integration_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe WeTransfer::Client do
+  let(:client) { WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY')) }
+  let(:file_locations) { %w[Japan-01.jpg Japan-02.jpg] }
+
+  describe described_class::Transfers do
+    pending 'creates a transfer with multiple files' do
+      skip "this interface is still experimental"
+      transfer = client.create_transfer(message: 'Japan: 🏯 & 🎎') do |builder|
+        file_locations.each do |file_location|
+          builder.add_file(name: File.basename(file_location), io: File.open(fixtures_dir + file_location, 'rb'))
+        end
+      end
+
+      expect(transfer).to be_kind_of(RemoteTransfer)
+
+      # it has an url that is not available (yet)
+      expect(transfer.url).to be(nil)
+      # it has no files (yet)
+      expect(transfer.files.first.url).to be(nil)
+      # it is in an uploading state
+      expect(transfer.state).to eq('uploading')
+
+      # TODO: uncouple file_locations and transfer.files
+      file_locations.each_with_index do |location, index|
+        client.upload_file(
+          object: transfer,
+          file: transfer.files[index],
+          io: File.open(fixtures_dir + location, 'rb')
+        )
+        client.complete_file!(
+          object: transfer,
+          file: transfer.files[index]
+        )
+      end
+
+      result = client.complete_transfer(transfer: transfer)
+
+      # it has an url that is available
+      expect(result.url =~ %r|^https://we.tl/t-|).to be_truthy
+
+      # it is in a processing state
+      expect(result.state).to eq('processing')
+
+      response = Faraday.get(result.url)
+      # it hits the short-url with redirect
+      expect(response.status).to eq(302)
+      expect(response['location']).to start_with('https://wetransfer.com/')
+    end
+  end
+end

data/spec/we_transfer_client/board_builder_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe BoardBuilder do
+  describe '#initialize' do
+    it 'initializes with an empty array' do
+      expect(subject.items.empty?).to be(true)
+    end
+  end
+
+  describe '#add_file' do
+    it 'returns an error when name is missing' do
+      expect {
+        subject.add_file(io: File.open(__FILE__, 'rb'))
+      }.to raise_error ArgumentError, /name/
+    end
+
+    it 'returns an error when io is missing' do
+      expect {
+        subject.add_file(name: 'file name')
+      }.to raise_error ArgumentError, /io/
+    end
+
+    it 'returns a error when file doesnt exists' do
+      expect {
+        subject.add_file(name: 'file name', io: File.open('foo', 'rb'))
+      }.to raise_error Errno::ENOENT
+    end
+
+    it 'adds a file when name and io is given' do
+      subject.add_file(name: 'file name', io: File.open(__FILE__, 'rb'))
+      expect(subject.items.first).to be_kind_of(FutureFile)
+    end
+  end
+
+  describe '#add_file_at' do
+    before do
+      skip "this interface is still experimental"
+    end
+
+    it 'adds a file from a path' do
+      subject.add_file_at(path: __FILE__)
+      expect(subject.items.first).to be_kind_of(FutureFile)
+    end
+
+    it 'throws a Error when file doesnt exists' do
+      expect {
+        subject.add_file_at(path: '/this/path/leads/to/nothing.exe')
+      }.to raise_error Errno::ENOENT
+    end
+
+    it 'should call #add_file' do
+      client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+      client.create_board(name: 'Test board', description: 'A board description') do |b|
+        expect(b).to receive(:add_file).with(name: anything, io: kind_of(::IO))
+        b.add_file_at(path: __FILE__)
+      end
+    end
+  end
+
+  describe '#add_web_url' do
+    it 'adds a item to board when url and title are given' do
+      subject.add_web_url(url: 'http://www.wetransfer.com', title: 'wetransfer')
+      expect(subject.items.first).to be_kind_of(FutureLink)
+    end
+  end
+end

data/spec/we_transfer_client/boards_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+require_relative '../../lib/we_transfer_client.rb'
+
+describe WeTransfer::Client::Boards do
+  describe '#create_board_and_upload_items' do
+    it 'creates a board and uploads the files' do
+      client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+      board = client.create_board_and_upload_items(name: 'test', description: 'test description') do |b|
+        b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+        b.add_web_url(url: 'http://www.wetransfer.com', title: 'WeTransfer Website')
+      end
+      expect(board).to be_kind_of(RemoteBoard)
+      expect(board.url).to start_with('https://we.tl/')
+      expect(board.state).to eq('downloadable')
+    end
+  end
+
+  describe "experimental features" do
+    before do
+      skip "this interface is still experimental"
+    end
+
+    describe '#create_board' do
+      it 'creates a board' do
+        client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+        board = client.create_board(name: 'test', description: 'test description')
+        expect(board).to be_kind_of(RemoteBoard)
+      end
+    end
+
+    describe "#add_items" do
+      it 'adds items to an existing board' do
+        client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+        board = client.create_board(name: 'test', description: 'test description')
+        updated_board = client.add_items(board: board) do |b|
+          b.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+          b.add_web_url(url: 'http://www.wetransfer.com', title: 'WeTransfer Website')
+        end
+        expect(updated_board).to be_kind_of(RemoteBoard)
+        expect(updated_board.items.size).to eq(2)
+        expect(updated_board.items.map(&:class)).to eq([RemoteFile, RemoteLink])
+      end
+    end
+
+    describe "#get_board" do
+      it 'gets board' do
+        client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+        board = client.create_board(name: 'test', description: 'test description')
+        board_request = client.get_board(board: board)
+
+        expect(board_request).to be_kind_of(RemoteBoard)
+      end
+    end
+  end
+end