wetransfer 0.4.4 → 0.9.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23567d27a90247e6e713d476da4d81bb01e4bebe
-  data.tar.gz: 3cec9fb058d7be32ffb779903f52a87fcc7f21c3
+SHA256:
+  metadata.gz: b84e32a738e08a8e53b7959fe659a1d37c3bfba4cbde3fcf7760100aa46c2a10
+  data.tar.gz: 147c343eec0216e9208bd56554e0463441dbbe557b3a2623d1d737bcfaa48a54
 SHA512:
-  metadata.gz: 30ec52713ad42fa38011232a1415618256d1e8c115c4da9e888eee1ad98df0658a997d42804b1044e297cecc0b2aa83e153919c491c12f8db620d94f5024af89
-  data.tar.gz: f526ff9408367d99eac5ab4eb3dd40a8933d19f8caf9e344e928472ea33b29599e70850b7b966afdefbe2bb6c7f929c098a24c06467c015eb8bd0a50cc5acd74
+  metadata.gz: 44aa5cbf35ee63f81e33ca574b8b98bb02e21cd161796b01bb5003d92efaed4720711dd21e0d5438ae74cf82a971fccbe4770e950651a75ce8da5aef5a582ede
+  data.tar.gz: 1aee6811bd67ba882f106339b94860ec83d54e3ab9c2ef9a7c8b417f8b72a8c0e971d903a981895ed99d10d2c8d4a2421f9e1928998cb0b662ebb00d9dea79df

data/.rspec

@@ -1,3 +1,2 @@
---format progress
 --order rand
---color
+--color

data/.rubocop.yml

@@ -1,2 +1,2 @@
 inherit_gem:
-  wetransfer_style: ruby/default.yml
+  wetransfer_style: ruby/default.yml

data/.travis.yml

@@ -1,8 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-- 2.1.0
-- 2.5.1
+- 2.3
+- 2.4
+- 2.5
 - jruby-9.0
 before_install: gem install bundler -v 1.16.1
 cache: bundler

data/Guardfile

@@ -0,0 +1,11 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  end
+
+  guard :rubocop, cmd: 'bundle exec rubocop' do
+    watch(%r{^lib/(.+)\.rb$})
+    watch(%r{^spec/(.+)\.rb$})
+  end
+end

data/README.md

@@ -1,6 +1,8 @@
 # WeTransfer Ruby SDK
 
-An open source Ruby SDK for the WeTransfer Public API
+The Ruby SDK that makes interacting with WeTransfer's Public API a breeze
+
+This gem can be used to create transfers (as seen on WeTransfer.com) and boards (as seen in our [iOS app](https://itunes.apple.com/app/apple-store/id765359021?pt=10422800&ct=wetransfer-developer-portal&mt=8) and [Android app](https://play.google.com/store/apps/details?id=com.wetransfer.app.live&referrer=utm_source%3Dwetransfer%26utm_medium%3Ddeveloper-portal) ) alike.
 
 For your API key and additional info please visit our [developer portal](https://developers.wetransfer.com).
 
@@ -9,99 +11,140 @@ For your API key and additional info please visit our [developer portal](https:/
 ## Table of Contents
 
 1. [Installation](#installation)
-2. [Usage](#usage)
-3. [Super simple transfers](#super-simple-transfers)
-4. [Development](#development)
-5. [Contributing](#contributing)
-6. [License](#license)
-7. [Code of Conduct](#code-of-conduct)
+1. [Getting started](#getting-started)
+1. [Transfers](#transfers)
+1. [Boards](#boards)
+1. [Development](#development)
+1. [Contributing](#contributing)
+1. [License](#license)
+1. [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'wetransfer'
+gem 'wetransfer', version: '0.9.0.beta1'
 ```
 
 And then execute:
 
-    $ bundle
+    bundle install
 
 Or install it yourself as:
 
-    $ gem install wetransfer
-
-## Usage
+    gem install wetransfer
 
-### Minimalist transfers
+## Getting started
 
 You'll need to retrieve an API key from [our developer portal](https://developers.wetransfer.com).
 
-Be sure to not commit this key to Github! If you do though, no worries, you can always revoke & create a new key from within the portal.
+Be sure to not commit this key to Github! If you do though, you can always revoke it and create a new key from within the portal.
 
-For configuring and storing secrets - like this API key - there are a variety of solutions. The smoothest here is creating a .env file:
+For configuring and storing secrets - like this API key - there are a variety of solutions. The smoothest here is creating a `.env` file, and use a gem like [dotenv](https://github.com/bkeepers/dotenv).
 
 Now that you've got a wonderful WeTransfer API key, create a .env file in your project folder:
 
-    $ touch .env
+    touch .env
+
+You don't want the contents of this file to leave your system. Ever.
+
+If the `.env` file is new, make sure to add it to your `.gitignore`, using the following command:
+
+    echo .env >> .gitignore
 
-Check your `.gitignore` file and make sure it has `.env` listed!
+Open the file in your text editor and add this line:
 
-Now, open the file in your text editor and add this line:
+    WT_API_KEY=<your api key>
 
-`WT_API_KEY=<your api key>` (without the <> brackets!)
+Make sure to replace `<your api key>` by your actual api key. Don't include the pointy brackets!
 
-Great! Now you can go to your project file and create the client:
+Great! Now you can go to your project file and use the client.
+
+## Transfers
+
+A transfer is a collection of files that can be created once, and downloaded until it expires. Once a transfer is ready for sharing, it is closed for modifications.
 
 ```ruby
 # In your project file:
 require 'we_transfer_client'
 
-@client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'))
+client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
 ```
 
-Now that you've got the client set up you can use  `create_transfer` to, well, create a transfer!
+Now that you've got the client set up you can use  `create_transfer_and_upload_files` to, well, create a transfer, and upload all files!
 
 ```ruby
-transfer = @client.create_transfer(name: "My wonderful transfer", description: "I'm so excited to share this") do |upload|
+transfer = client.create_transfer_and_upload_files(message: 'All the Things') do |upload|
   upload.add_file_at(path: '/path/to/local/file.jpg')
   upload.add_file_at(path: '/path/to/another/local/file.jpg')
-  upload.add_file(name: 'README.txt', io: StringIO.new("This is the contents of the file"))
-  upload.add_web_url(url: "https://www.the.url.you.want.to.share.com", title: "title of the url"))
+  upload.add_file(name: 'README.txt', io: StringIO.new("You should read All the Things!"))
 end
 
-transfer.shortened_url => "https://we.tl/SSBsb3ZlIHJ1Ynk="
+# To get a link to your transfer, call `url` on your transfer object:
+transfer.url => "https://we.tl/t-123234="
 ```
 
-The upload will be performed at the end of the block.
+The upload will be performed at the end of the block. Depending on your file sizes and network connection speed, this might take some time.
+
+What are you waiting for? Open that link in your browser! Chop chop.
+
+## Boards
+
+A board is a collection of files and links, but it is open for modifications. Like your portfolio: While working, you can make adjustments to it. A board is a fantastic place for showcasing your work in progress.
+
+Boards need a WeTransfer Client to be present, just like transfers.
+
+```ruby
+# In your project file:
+require 'we_transfer_client'
+
+client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+```
+
+After you create your client, you can
+
+### Create a board and upload items
+
+
+```ruby
+board = client.create_board(name: 'Meow', description: 'On Cats') do |items|
+  items.add_file(name: 'big file.jpg', io: File.open('/path/to/huge_file.jpg', 'rb')items.add_file_at(path: '/path/to/another/file.txt')
+  items.add_web_url(url: 'http://wepresent.wetransfer.com', title: 'Time well spent')
+end
+
+puts board.url # => "https://we.tl/b-923478"
+```
+
+You've just created a board. It is visible on the internet, to share it with anyone.
 
 ## Development
+
 You'll need to retrieve an API key from [our developer portal](https://developers.wetransfer.com), and as described above, store it in a local `.env` file. As always, do not commit this file to github! :)
 
 After forking and cloning down the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-```
-$ git clone <your fork>
-$ cd wetransfer_ruby_sdk
-$ bundle install
-```
+    git clone <your fork> ./wetransfer_ruby_sdk
+    cd wetransfer_ruby_sdk
+    bundle install
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 To execute to ruby specs, run:
 
-```
-$ bundle exec rspec
-```
+    bundle exec rspec
 
 Please note that we use rubocop to lint this gem -- be sure to run it prior to submitting a PR for maximum mergeability.
 
-    $ bundle exec rubocop
+    bundle exec rubocop
+
+If any violations can be handled by rubocop, you can run auto-fix and it'll handle them for you, though do run the tests again and make sure it hasn't done something... unexpected.
+
+    bundle exec rubocop -a
 
-If any violations can be handled by rubocop, you can run auto-fix and it'll handle them for you, though do run the tests again and make sure it hasn't done something ... unexpected.
+For more convenience you also can run Guard, this checks all the tests and runs rubocop every time you save your files.
 
-    $ bundle exec rubocop -a
+    bundle exec guard
 
 Hooray!
 
@@ -115,4 +158,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the WeTransfer Ruby SDK project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/.github/CODE_OF_CONDUCT.md).
+Everyone interacting in the WeTransfer Ruby SDK project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/.github/CODE_OF_CONDUCT.md).

data/V2_README.md

@@ -0,0 +1,53 @@
+The process
+
+In the v2 version of the Ruby SDK we have added a new feature, mutable transfers called boards.
+
+Boards excists next to the transfers and will be mutable, so you can add new files or web_links to your board.
+
+
+To use the ruby sdk you have to Initailize a new client with your API-Key:
+
+```
+client = WeTransfer::Client.new(api_key: 'your-special-api-key')
+```
+
+### Initailize a Board
+
+Once you created that new client you can call methods to create a new board, empty or as a block:
+
+```
+board = client.create_board(name: 'File Collection', description: 'A collection of files')
+```
+or:
+```
+board = client.create_board(name: 'Dog Collection', description: 'A collection of dogs') do |item|
+  item.add_file(name: 'dalmatian.jpg', io: File.open('path/to/dalmatian.jpg', 'r'))
+  item.add_file(name: 'beagle.jpg', io: File.open('path/to/beagle.jpg', 'r'))
+  item.add_file(name: 'great_dane.jpg', io: File.open('path/to/great_dane.jpg', 'r'))
+  item.add_web_url(url: 'http://www.wetransfer.com', title: 'WeTransfer Website')
+end
+```
+
+### Initialize a Transfer
+
+For initializing a transfer the process is like this:
+
+```ruby
+transfer = @client.create_transfer(name: "Dog transfer", description: "Have a look at my dogs") do |upload|
+  upload.add_file(name: 'chihuahua.jpg', io: File.open('path/to/chihuahua.jpg', 'r'))
+  upload.add_file(name: 'chow_chow.jpg', io: File.open('path/to/chow_chow.jpg', 'r'))
+end
+
+transfer.shortened_url => "https://we.tl/SSBsb3ZlIHJ1Ynk="
+```
+
+Note: For initializing a transfer you have to pass all the files directly so the backend knows what you are uploading.
+
+
+
+### uploading the files
+
+For both the transfer and board, the files are not in you transfer or collection, yet.
+
+The files need to be uploaded and finalized
+

data/examples/create_collection.rb

@@ -0,0 +1,13 @@
+require_relative 'we_transfer_client'
+require 'dotenv'
+Dotenv.load
+
+client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
+transfer = client.create_transfer(name: 'My amazing transfer', description: 'Hi there!') do |builder|
+  builder.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+  builder.add_file(name: 'amazing.txt', io: StringIO.new('This is unbelievable'))
+  builder.add_file(name: 'huge.bin', io: File.open('/path/to/local/file.jpg', 'rb'))
+  builder.add_file_at(path: __FILE__)
+end
+
+puts transfer.shortened_url

data/examples/create_transfer.rb

@@ -2,7 +2,7 @@ require_relative 'we_transfer_client'
 require 'dotenv'
 Dotenv.load
 
-client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY')) # , logger: Logger.new($stderr))
+client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
 transfer = client.create_transfer(name: 'My amazing transfer', description: 'Hi there!') do |builder|
   builder.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
   builder.add_file(name: 'amazing.txt', io: StringIO.new('This is unbelievable'))

data/lib/we_transfer_client/board_builder.rb

@@ -0,0 +1,33 @@
+class BoardBuilder
+  attr_reader :items
+  class TransferIOError < StandardError; end
+
+  def initialize
+    @items = []
+  end
+
+  def add_file(name:, io:)
+    ensure_io_compliant!(io)
+    @items << FutureFile.new(name: name, io: io)
+  end
+
+  def add_file_at(path:)
+    add_file(name: File.basename(path), io: File.open(path, 'rb'))
+  end
+
+  def add_web_url(url:, title: url)
+    @items << FutureLink.new(url: url, title: title)
+  end
+
+  private
+
+  def ensure_io_compliant!(io)
+    io.seek(0)
+    io.read(1) # Will cause things like Errno::EACCESS to happen early, before the upload begins
+    io.seek(0) # Also rewinds the IO for later uploading action
+    size = io.size # Will cause a NoMethodError
+    raise TransferIOError, "#{File.basename(io)}, given to add_file has a size of 0" if size <= 0
+  rescue NoMethodError
+    raise TransferIOError, "#{File.basename(io)}, given to add_file must respond to seek(), read() and size(), but #{io.inspect} did not"
+  end
+end

data/lib/we_transfer_client/boards.rb

@@ -0,0 +1,74 @@
+module WeTransfer
+  class Client
+    module Boards
+      def create_board_and_upload_items(name:, description:, &block)
+        future_board = create_feature_board(name: name, description: description, &block)
+        remote_board = create_remote_board(board: future_board)
+        remote_board.files.each do |file|
+          check_for_file_duplicates(future_board.files, file)
+          local_file = future_board.files.select { |x| x.name == file.name }.first
+          upload_file(object: remote_board, file: file, io: local_file.io)
+          complete_file!(object: remote_board, file: file)
+        end
+        remote_board
+      end
+
+      def get_board(board:)
+        request_board(board: board)
+      end
+
+      private
+
+      def create_board(name:, description:, &block)
+        future_board = create_feature_board(name: name, description: description, &block)
+        create_remote_board(board: future_board)
+      end
+
+      def add_items(board:, board_builder_class: BoardBuilder)
+        builder = board_builder_class.new
+        yield(builder)
+        add_items_to_remote_board(items: builder.items, remote_board: board)
+      rescue LocalJumpError
+        raise ArgumentError, 'No items where added to the board'
+      end
+
+      def create_feature_board(name:, description:, future_board_class: FutureBoard, board_builder_class: BoardBuilder)
+        builder = board_builder_class.new
+        yield(builder) if block_given?
+        future_board_class.new(name: name, description: description, items: builder.items)
+      end
+
+      def create_remote_board(board:, remote_board_class: RemoteBoard)
+        authorize_if_no_bearer_token!
+        response = faraday.post(
+          '/v2/boards',
+          JSON.pretty_generate(board.to_initial_request_params),
+          auth_headers.merge('Content-Type' => 'application/json')
+        )
+        ensure_ok_status!(response)
+        remote_board = remote_board_class.new(JSON.parse(response.body, symbolize_names: true))
+        board.items.any? ? add_items_to_remote_board(items: board.items, remote_board: remote_board) : remote_board
+      end
+
+      def add_items_to_remote_board(items:, remote_board:)
+        items.group_by(&:class).each do |_, grouped_items|
+          grouped_items.each do |item|
+            item.add_to_board(client: self, remote_board: remote_board)
+          end
+        end
+        remote_board
+      end
+
+      def request_board(board:, remote_board_class: RemoteBoard)
+        authorize_if_no_bearer_token!
+        response = faraday.get(
+          "/v2/boards/#{board.id}",
+          {},
+          auth_headers.merge('Content-Type' => 'application/json')
+        )
+        ensure_ok_status!(response)
+        remote_board_class.new(JSON.parse(response.body, symbolize_names: true))
+      end
+    end
+  end
+end

data/lib/we_transfer_client/future_board.rb

@@ -0,0 +1,32 @@
+class FutureBoard
+  attr_reader :name, :description, :items
+
+  def initialize(name:, description: nil, items: [])
+    @name = name
+    @description = description
+    @items = items
+  end
+
+  def files
+    @items.select { |item| item.class == FutureFile }
+  end
+
+  def links
+    @items.select { |item| item.class == FutureLink }
+  end
+
+  def to_initial_request_params
+    {
+      name: name,
+      description: description,
+    }
+  end
+
+  def to_request_params
+    {
+      name: name,
+      description: description,
+      items: items.map(&:to_request_params),
+    }
+  end
+end