wetransfer 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b5bfa1c6ff82d87a1f5bd0df47c3af5ceff2163
-  data.tar.gz: 0a285f8cacb13b4ee36c85d1c8dbba71c8b94543
+  metadata.gz: 6c3bcf1003d1940a7f374bc5e395ed0c0ed245c5
+  data.tar.gz: 6a9d0d2dcb79b3d9645836a689af75f4623131e1
 SHA512:
-  metadata.gz: ceef985fc774024519eeb25ffd454b879148c58241dcee6e82a2c38dddf767ae2711a8e601e15a902a3636fa160d973eb3cf3bde67e8062d6a99b88c374ee01c
-  data.tar.gz: 62cfcc59be9f9e197b3cdbd9e43759f406f290edff63b65313568cd3c57e0e730f529b4f328620c56578e553189cc856142b14b28e52b26689c24970396ed26b
+  metadata.gz: e8e7ce672d56cae479a45c2f8dc370f5a87515c4d55dae54ecd0106250d0d0e1d06b82e687a19dc376e24d0fd51b063d57d9a92815fdbcc4cad33fcae9fc60c7
+  data.tar.gz: 3c3d91e6bab75ea66f4a79e3248b4363bffe1c08e0f3a798c24d7275eaf50a5a42067ef1b78bbfc7adcd2a2093d96898b07f84e1ea66ec7b0b96263443646fa6

data/.gitignore

@@ -11,4 +11,4 @@
 
 # rspec failure tracking
 .rspec_status
-.env
+.env

data/.rubocop.yml

@@ -1,6 +1,2 @@
 inherit_gem:
   wetransfer_style: ruby/default.yml
-AllCops:
-  Exclude:
-    - 'vendor/**/*'
-    - './spec/test_server.rb'

data/.travis.yml

@@ -10,5 +10,6 @@ matrix:
   allow_failures:
     - rvm: jruby-9.0
 script:
-  - bundle exec rspec
+  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then bundle exec rspec --exclude-pattern "spec/integration_spec.rb"; fi'
+  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then bundle exec rspec; fi'
   - bundle exec rubocop -c .rubocop.yml --force-exclusion

data/README.md

@@ -68,6 +68,7 @@ transfer = @client.create_transfer(name: "My wonderful transfer", description: "
   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_content(path: "https://www.the.url.you.want.to.share.com"))
 end
 
 transfer.shortened_url => "https://we.tl/SSBsb3ZlIHJ1Ynk="
@@ -114,4 +115,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/lib/we_transfer_client.rb

@@ -3,78 +3,23 @@ require 'logger'
 require 'ks'
 require 'securerandom'
 require 'json'
+require 'open-uri'
+require 'open_uri_redirections'
 
 class WeTransferClient
   require_relative 'we_transfer_client/version'
+  require_relative 'we_transfer_client/future_file_item'
+  require_relative 'we_transfer_client/future_web_item'
+  require_relative 'we_transfer_client/future_transfer'
+  require_relative 'we_transfer_client/transfer_builder'
+  require_relative 'we_transfer_client/remote_transfer'
+  require_relative 'we_transfer_client/remote_item'
 
   class Error < StandardError
   end
 
   NULL_LOGGER = Logger.new(nil)
   MAGIC_PART_SIZE = 6 * 1024 * 1024
-  EXPOSED_COLLECTION_ATTRIBUTES = [:id, :version_identifier, :state, :shortened_url, :name, :description, :size, :items]
-  EXPOSED_ITEM_ATTRIBUTES = [:id, :local_identifier, :content_identifier, :name, :size, :mime_type]
-
-  class FutureFileItem < Ks.strict(:name, :io, :local_identifier)
-    def initialize(**kwargs)
-      super(local_identifier: SecureRandom.uuid, **kwargs)
-    end
-
-    def to_item_request_params
-      # Ideally the content identifier should stay the same throughout multiple
-      # calls if the file contents doesn't change.
-      {
-        content_identifier: 'file',
-        local_identifier: local_identifier,
-        filename: name,
-        filesize: io.size,
-      }
-    end
-  end
-
-  class TransferBuilder
-    attr_reader :items
-
-    def initialize
-      @items = []
-    end
-
-    def add_file(name:, io:)
-      ensure_io_compliant!(io)
-      @items << FutureFileItem.new(name: name, io: io)
-      true
-    end
-
-    def add_file_at(path:)
-      add_file(name: File.basename(path), io: File.open(path, 'rb'))
-    end
-
-    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 Error, 'The IO object given to add_file has a size of 0' if size <= 0
-    rescue NoMethodError
-      raise Error, "The IO object given to add_file must respond to seek(), read() and size(), but #{io.inspect} did not"
-    end
-  end
-
-  class FutureTransfer < Ks.strict(:name, :description, :items)
-    def to_create_transfer_params
-      {
-        name: name,
-        description: description,
-        items: items.map(&:to_item_request_params),
-      }
-    end
-  end
-
-  class RemoteTransfer < Ks.strict(*EXPOSED_COLLECTION_ATTRIBUTES)
-  end
-
-  class RemoteItem < Ks.strict(*EXPOSED_ITEM_ATTRIBUTES)
-  end
 
   def initialize(api_key:, logger: NULL_LOGGER)
     @api_url_base = 'https://dev.wetransfer.com'
@@ -114,7 +59,9 @@ class WeTransferClient
 
     create_transfer_response.fetch(:items).each do |remote_item|
       local_item = item_id_map.fetch(remote_item.fetch(:local_identifier))
+      next unless local_item.is_a?(FutureFileItem)
       remote_item_id = remote_item.fetch(:id)
+
       put_io_in_parts(
         remote_item_id,
         remote_item.fetch(:meta).fetch(:multipart_parts),
@@ -129,7 +76,6 @@ class WeTransferClient
       )
       ensure_ok_status!(complete_response)
     end
-
     remote_transfer
   end
 

data/lib/we_transfer_client/future_file_item.rb

@@ -0,0 +1,16 @@
+class FutureFileItem < Ks.strict(:name, :io, :local_identifier)
+  def initialize(**kwargs)
+    super(local_identifier: SecureRandom.uuid, **kwargs)
+  end
+
+  def to_item_request_params
+    # Ideally the content identifier should stay the same throughout multiple
+    # calls if the file contents doesn't change.
+    {
+      content_identifier: 'file',
+      local_identifier: local_identifier,
+      filename: name,
+      filesize: io.size,
+    }
+  end
+end

data/lib/we_transfer_client/future_transfer.rb

@@ -0,0 +1,9 @@
+class FutureTransfer < Ks.strict(:name, :description, :items)
+  def to_create_transfer_params
+    {
+      name: name,
+      description: description,
+      items: items.map(&:to_item_request_params),
+    }
+  end
+end

data/lib/we_transfer_client/future_web_item.rb

@@ -0,0 +1,18 @@
+class FutureWebItem < Ks.strict(:url, :title, :local_identifier)
+  def initialize(**kwargs)
+    super(local_identifier: SecureRandom.uuid, **kwargs)
+  end
+
+  def to_item_request_params
+    # Ideally the content identifier should stay the same throughout multiple
+    # calls if the file contents doesn't change.
+    {
+      content_identifier: 'web_content',
+      local_identifier: local_identifier,
+      url: url,
+      meta: {
+        title: title
+      }
+    }
+  end
+end

data/lib/we_transfer_client/remote_item.rb

@@ -0,0 +1,2 @@
+class RemoteItem < Ks.strict(:id, :local_identifier, :content_identifier, :name, :size, :mime_type, :url, :title)
+end

data/lib/we_transfer_client/remote_transfer.rb

@@ -0,0 +1,2 @@
+class RemoteTransfer < Ks.strict(:id, :version_identifier, :state, :shortened_url, :name, :description, :size, :items)
+end

data/lib/we_transfer_client/transfer_builder.rb

@@ -0,0 +1,35 @@
+class TransferBuilder
+  attr_reader :items
+  class TransferIOError < StandardError; end
+
+  def initialize
+    @items = []
+  end
+
+  def add_file(name:, io:)
+    ensure_io_compliant!(io)
+    @items << FutureFileItem.new(name: name, io: io)
+    true
+  end
+
+  def add_file_at(path:)
+    add_file(name: File.basename(path), io: File.open(path, 'rb'))
+  end
+
+  def add_web_content(path:)
+    url = open(path, allow_redirections: :safe).base_uri.to_s
+    url_title = url.split('/').last
+    @items << FutureWebItem.new(url: url, title: url_title)
+    true
+  end
+
+  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, 'The IO object given to add_file has a size of 0' if size <= 0
+  rescue NoMethodError
+    raise TransferIOError, "The IO object given to add_file must respond to seek(), read() and size(), but #{io.inspect} did not"
+  end
+end

data/lib/we_transfer_client/version.rb

@@ -1,3 +1,3 @@
 class WeTransferClient
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/spec/integration_spec.rb

@@ -15,10 +15,6 @@ describe WeTransferClient do
     tf
   end
 
-  it 'exposes VERSION' do
-    expect(WeTransferClient::VERSION).to be_kind_of(String)
-  end
-
   it 'is able to create a transfer start to finish, both with small and large files' do
     client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
     transfer = client.create_transfer(name: 'My amazing board', description: 'Hi there!') do |builder|
@@ -37,7 +33,7 @@ describe WeTransferClient do
       expect(add_result).to eq(true)
     end
 
-    expect(transfer).to be_kind_of(WeTransferClient::RemoteTransfer)
+    expect(transfer).to be_kind_of(RemoteTransfer)
     expect(transfer.id).to be_kind_of(String)
 
     # expect(transfer.version_identifier).to be_kind_of(String)
@@ -48,7 +44,7 @@ describe WeTransferClient do
     expect(transfer.items.length).to eq(3)
 
     item = transfer.items.first
-    expect(item).to be_kind_of(WeTransferClient::RemoteItem)
+    expect(item).to be_kind_of(RemoteItem)
 
     expect(transfer.shortened_url).to be_kind_of(String)
     response = Faraday.get(transfer.shortened_url)
@@ -96,4 +92,69 @@ describe WeTransferClient do
       end
     }.to raise_error(/has a size of 0/)
   end
+
+  it 'is able to create a transfer with only webcontent' do
+    client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
+    transfer = client.create_transfer(name: 'My collection of web content', description: 'link collection') do |builder|
+      10.times do
+        builder.add_web_content(path: 'https://www.wetransfer.com')
+      end
+    end
+    expect(transfer).to be_kind_of(RemoteTransfer)
+    expect(transfer.id).to be_kind_of(String)
+
+    # expect(transfer.version_identifier).to be_kind_of(String)
+    expect(transfer.state).to be_kind_of(String)
+    expect(transfer.name).to eq('My collection of web content')
+    expect(transfer.description).to eq('link collection')
+    expect(transfer.items).to be_kind_of(Array)
+    expect(transfer.items.length).to eq(10)
+
+    item = transfer.items.first
+    expect(item).to be_kind_of(RemoteItem)
+
+    expect(transfer.shortened_url).to be_kind_of(String)
+    response = Faraday.get(transfer.shortened_url)
+    expect(response.status).to eq(302)
+    expect(response['location']).to start_with('https://wetransfer')
+  end
+
+  it 'is able to create a transfer with web_content and files' do
+    client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
+    transfer = client.create_transfer(name: 'Mixed Board Content', description: 'Files and Webcontent') do |builder|
+      # Upload ourselves
+      add_result = builder.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
+      expect(add_result).to eq(true)
+
+      # Upload ourselves again, but using add_file_at
+      add_result = builder.add_file_at(path: __FILE__) # Upload ourselves again, but this time via path
+      expect(add_result).to eq(true)
+
+      # Upload the large file
+      add_result = builder.add_file(name: 'large.bin', io: very_large_file)
+      expect(add_result).to eq(true)
+
+      # add url to transfer
+      add_result = builder.add_web_content(path: 'http://www.wetransfer.com')
+      expect(add_result).to eq(true)
+    end
+
+    expect(transfer).to be_kind_of(RemoteTransfer)
+    expect(transfer.id).to be_kind_of(String)
+
+    # expect(transfer.version_identifier).to be_kind_of(String)
+    expect(transfer.state).to be_kind_of(String)
+    expect(transfer.name).to eq('Mixed Board Content')
+    expect(transfer.description).to eq('Files and Webcontent')
+    expect(transfer.items).to be_kind_of(Array)
+    expect(transfer.items.length).to eq(4)
+
+    item = transfer.items.first
+    expect(item).to be_kind_of(RemoteItem)
+
+    expect(transfer.shortened_url).to be_kind_of(String)
+    response = Faraday.get(transfer.shortened_url)
+    expect(response.status).to eq(302)
+    expect(response['location']).to start_with('https://wetransfer')
+  end
 end

data/spec/we_transfer_client/future_file_item_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe FutureFileItem do
+  it 'errors if not given all required arguments' do
+    expect {
+      described_class.new(name: 'nope', local_identifier: 'sorry')
+    }.to raise_error(/missing keyword: io/)
+
+    expect {
+      described_class.new(io: 'nope')
+    }.to raise_error(/missing keyword: name/)
+  end
+
+  it 'succeeds if given all arguments' do
+    future_file_item = described_class.new(name: 'yes', io: 'hello', local_identifier: '4815162342')
+    expect(future_file_item).to be_kind_of(FutureFileItem)
+  end
+
+  it 'succeeds if not passed a local_identifier' do
+    future_file_item = described_class.new(name: 'yes', io: 'hello')
+    expect(future_file_item).to be_kind_of(FutureFileItem)
+  end
+
+  it 'generates a local_identifier' do
+    future_file_item = described_class.new(name: 'who', io: 'ami')
+    expect(future_file_item).to be_kind_of(FutureFileItem)
+    expect(future_file_item.local_identifier).to_not be nil
+    expect(future_file_item.local_identifier).to be_kind_of(String)
+  end
+
+  it 'creates params properly' do
+    future_file_item = described_class.new(name: 'yes', io: 'hello')
+    item_as_params = future_file_item.to_item_request_params
+    expect(item_as_params[:content_identifier]).to eq('file')
+    expect(item_as_params[:local_identifier]).to be_kind_of(String)
+    expect(item_as_params[:filename]).to eq('yes')
+    expect(item_as_params[:filesize]).to eq(5)
+  end
+end

data/spec/we_transfer_client/future_transfer_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe FutureTransfer do
+  it 'errors if not given all required arguments' do
+    expect {
+      described_class.new(name: 'nope', description: 'sorry')
+    }.to raise_error(/missing keyword: items/)
+
+    expect {
+      described_class.new(description: 'lol', items: [])
+    }.to raise_error(/missing keyword: name/)
+
+    expect {
+      described_class.new(name: 'lol', items: [])
+    }.to raise_error(/missing keyword: description/)
+  end
+
+  it 'succeeds if given all required arguments' do
+    future_transfer = described_class.new(name: 'frank', description: 'a decent bloke', items: [])
+    expect(future_transfer).to be_kind_of(FutureTransfer)
+  end
+end

data/spec/we_transfer_client/future_web_item_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe FutureWebItem do
+  it 'errors if not given all required arguments' do
+    expect {
+      described_class.new(url: 'https://www.wetransfer.com', local_identifier: '321235151')
+    }.to raise_error(/missing keyword: title/)
+
+    expect {
+      described_class.new(title: 'wetransfer.com')
+    }.to raise_error(/missing keyword: url/)
+  end
+
+  it 'succeeds if given all arguments' do
+    future_web_item = described_class.new(url: 'https://www.wetransfer.com', title: 'wetransfer.com', local_identifier: '321235151')
+    expect(future_web_item).to be_kind_of(FutureWebItem)
+  end
+
+  it 'succeeds if not passed a local_identifier' do
+    future_web_item = described_class.new(url: 'https://www.wetransfer.com', title: 'wetransfer.com')
+    expect(future_web_item).to be_kind_of(FutureWebItem)
+  end
+
+  it 'generates a local_identifier' do
+    future_web_item = described_class.new(url: 'https://www.wetransfer.com', title: 'wetransfer.com')
+    expect(future_web_item).to be_kind_of(FutureWebItem)
+    expect(future_web_item.local_identifier).to_not be nil
+    expect(future_web_item.local_identifier).to be_kind_of(String)
+  end
+
+  it 'creates params properly' do
+    future_web_item = described_class.new(url: 'https://www.wetransfer.com', title: 'wetransfer.com')
+    item_as_params = future_web_item.to_item_request_params
+    expect(item_as_params[:content_identifier]).to eq('web_content')
+    expect(item_as_params[:local_identifier]).to be_kind_of(String)
+    expect(item_as_params[:url]).to eq('https://www.wetransfer.com')
+    expect(item_as_params[:meta][:title]).to eq('wetransfer.com')
+  end
+end

data/spec/we_transfer_client/transfer_builder_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe TransferBuilder do
+  it 'raises if given an item with a size of 0' do
+    broken = StringIO.new('')
+    expect {
+      described_class.new.ensure_io_compliant!(broken)
+    }.to raise_error(/The IO object given to add_file has a size of 0/)
+  end
+
+  it 'raises if IO raises an error' do
+    broken = []
+
+    expect {
+      described_class.new.ensure_io_compliant!(broken)
+    }.to raise_error(TransferBuilder::TransferIOError)
+  end
+
+  it 'adds a file' do
+    transfer_builder = described_class.new
+    transfer_builder.add_file_at(path: __FILE__)
+    expect(transfer_builder.items.count).to eq(1)
+
+    item = transfer_builder.items.first
+    expect(item.name).to eq('transfer_builder_spec.rb')
+    expect(item.io).to be_kind_of(File)
+    expect(item.local_identifier).to be_kind_of(String)
+  end
+
+  it 'should add a url' do
+    transfer_builder = described_class.new
+    transfer_builder.add_web_content(path: 'https://www.wetransfer.com')
+    expect(transfer_builder.items.count).to eq(1)
+
+    item = transfer_builder.items.first
+    expect(item.url).to eq('https://wetransfer.com/')
+    expect(item.title).to eq('wetransfer.com')
+    expect(item.local_identifier).to be_kind_of(String)
+  end
+end

data/spec/we_transfer_client_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+require_relative '../lib/we_transfer_client.rb'
+
+describe WeTransferClient do
+  it 'exposes VERSION' do
+    expect(WeTransferClient::VERSION).to be_kind_of(String)
+  end
+end

data/wetransfer.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
     Please update your usage accordingly. Thank you and our apologies for the disruption.
   }
 
-  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'faraday', '~> 0.12'
   spec.add_dependency 'ks', '~> 0.0.1'
 
   spec.add_development_dependency 'dotenv', '~> 2.2'
@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'wetransfer_style', '0.5.0'
+  spec.add_development_dependency 'open_uri_redirections'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wetransfer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: ks
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: open_uri_redirections
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby bindings for using WeTransfer's Public API.
 email:
 - noah@wetransfer.com
@@ -164,9 +178,20 @@ files:
 - bin/setup
 - examples/create_transfer.rb
 - lib/we_transfer_client.rb
+- lib/we_transfer_client/future_file_item.rb
+- lib/we_transfer_client/future_transfer.rb
+- lib/we_transfer_client/future_web_item.rb
+- lib/we_transfer_client/remote_item.rb
+- lib/we_transfer_client/remote_transfer.rb
+- lib/we_transfer_client/transfer_builder.rb
 - lib/we_transfer_client/version.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
+- spec/we_transfer_client/future_file_item_spec.rb
+- spec/we_transfer_client/future_transfer_spec.rb
+- spec/we_transfer_client/future_web_item_spec.rb
+- spec/we_transfer_client/transfer_builder_spec.rb
+- spec/we_transfer_client_spec.rb
 - wetransfer.gemspec
 homepage: https://developers.wetransfer.com
 licenses:
@@ -192,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A Ruby SDK for WeTransfer's Public API