wetransfer 0.1.0

data/spec/item_builder_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe WeTransfer::ItemBuilder do
+  describe 'ItemBuilder process' do
+    let(:item_builder) { described_class.new }
+
+    it 'makes a new Item if no item is given on initialze' do
+      expect(item_builder).to be_an_instance_of(WeTransfer::ItemBuilder)
+      expect(item_builder.item).to be_an_instance_of(WeTransfer::Item)
+    end
+
+    it 'uses the item, when a item is given to the ItemBuilder' do
+      builder_item = described_class.new(item: item_builder.item)
+      expect(builder_item).to be_an_instance_of(WeTransfer::ItemBuilder)
+      expect(builder_item.item).to be_an_instance_of(WeTransfer::Item)
+    end
+
+    it 'sets the path when path method is called' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      expect(item_builder.item.path).to eq("#{__dir__}/fixtures/war-and-peace.txt")
+    end
+
+    it 'sets content always to file' do
+      item_builder.content_identifier
+      expect(item_builder.item.content_identifier).to eq('file')
+    end
+
+    it 'sets the local local_identifier to the first 36 characters of the file name' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.local_identifier
+      expect(item_builder.item.local_identifier).to eq('war-and-peace.txt')
+      expect(item_builder.item.local_identifier.length).to be <= 36
+    end
+
+    it 'sets the local local_identifier to the first 36 characters of the file name' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace-and-peace-and-war-and-war-and-peace.txt")
+      item_builder.local_identifier
+      expect(item_builder.item.local_identifier).to eq('war-and-peace-and-peace-and-war-and-')
+      expect(item_builder.item.local_identifier.length).to be <= 36
+    end
+
+    it 'sets the item name according to the given path' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.name
+      expect(item_builder.item.name).to eq('war-and-peace.txt')
+    end
+
+    it 'sets the filesize by reading the file' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.size
+      expect(item_builder.item.size).to_not be_nil
+      expect(item_builder.item.size).to eq(485192)
+    end
+
+    it 'sets the id according to the api response' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.id(item: item_builder.item, id: 1234)
+      expect(item_builder.item.id).to eq(1234)
+    end
+
+    it 'sets the upload url according to the api response' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.upload_url(item: item_builder.item, url: "#{ENV.fetch('WT_API_URL')}/upload/#{SecureRandom.hex(9)}")
+      expect(item_builder.item.upload_url).to_not be_nil
+    end
+
+    it 'sets the multipart_parts according to the api response' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.multipart_parts(item: item_builder.item, part_count: 3)
+      expect(item_builder.item.multipart_parts).to eq(3)
+    end
+
+    it 'sets the multipart_id according to the api response' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.multipart_id(item: item_builder.item, multi_id: 1234567890)
+      expect(item_builder.item.multipart_id).to eq(1234567890)
+    end
+
+    it 'sets the upload_id according to the api response' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      item_builder.upload_id(item: item_builder.item, upload_id: 1234567890)
+      expect(item_builder.item.upload_id).to eq(1234567890)
+    end
+
+    it 'returns the item object when ItemBuilder item method is calles' do
+      item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+      expect(item_builder.item).to be_an_instance_of(WeTransfer::Item)
+    end
+
+    it 'validates the file if it exists on the path given' do
+      expect {
+        item_builder.path(path: "#{__dir__}/fixtures/war-and-peace.txt")
+        item_builder.validate_file
+      }.to_not raise_error
+    end
+
+    it 'validates the file if it exists on the path given and returns with FileDoesNotExistError' do
+      expect {
+        item_builder.path(path: "#{__dir__}/peace-and-war.txt")
+        item_builder.validate_file
+      }.to raise_error(WeTransfer::ItemBuilder::FileDoesNotExistError, "#{item_builder.item} does not exist")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'wetransfer'
+require 'pry'
+require 'rspec'
+require_relative 'test_server'
+
+RSpec.configure do |config|
+  config.before :suite do
+    TestServer.start(nil)
+    ENV['WT_API_URL'] = 'http://localhost:9001'
+    ENV['WT_API_CONNECTION_PATH'] = '/v1'
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/test_server.rb

@@ -0,0 +1,208 @@
+require 'webrick'
+require 'securerandom'
+include WEBrick
+
+class ForbiddenServlet < HTTPServlet::AbstractServlet
+  def do_GET(_req, res)
+    res['Content-Type'] = 'application/json'
+    res.status = 403
+  end
+  def do_POST(_req, res)
+    res['Content-Type'] = 'application/json'
+    res.status = 403
+  end
+end
+
+class AuthServlet < HTTPServlet::AbstractServlet
+  def do_POST(req, res)
+    if req.header["x-api-key"].empty?
+      res['Content-Type'] = 'application/json'
+      res.status = 401
+    else
+      res['Content-Type'] = 'application/json'
+      res.status = 200
+      res.body = {status: 'success', token: SecureRandom.hex(4)}.to_json
+    end
+  end
+end
+
+class TransfersServlet < HTTPServlet::AbstractServlet
+  def self.do_POST(req, res)
+    content = JSON.parse(req.body)
+    items_count = content["items"].count || 0
+    res['Content-Type'] = 'application/json'
+    res.status = 200
+    res.body = {shortened_url: "http://we.tl/s-#{SecureRandom.hex(5)}",
+                id: SecureRandom.hex(9),
+                name: content["name"],
+                description: content["description"],
+                size: totalsize_calc(items: content["items"]),
+                total_items: content["items"].count,
+                version_identifier: nil,
+                state: 'uploading',
+                items: item_params(items: content["items"])}.to_json
+  end
+
+  private
+
+  def self.item_params(items:)
+    items_array = []
+    items.each do |item|
+      items_array << {id: SecureRandom.hex(9),
+                      local_identifier: item['filename'][0..36],
+                      name: item['filename'],
+                      size: item['filesize'],
+                      meta:{
+                        multipart_parts: multipart_calc(item: item),
+                        multipart_id: SecureRandom.hex(9),
+                      },
+                      upload_url:"#{ENV.fetch('WT_API_URL')}/upload/#{SecureRandom.hex(9)}",
+                      upload_id: SecureRandom.hex(9),
+                      upload_expires_at: (Time.now + 5).to_i
+                    }
+    end
+    return items_array
+  end
+
+  def self.totalsize_calc(items:)
+    total_size = []
+    items.each do |item|
+      total_size << item['filesize']
+    end
+    total_size.reduce(0, :+)
+  end
+
+  def self.multipart_calc(item:)
+    parts = item['filesize'] / 6291456
+    parts == 0 ? 1 : parts
+  end
+end
+
+class UploadUrlServlet < HTTPServlet::AbstractServlet
+  def self.do_GET(_req, res)
+    part_number = res.request_uri.to_s.split('/')[-2]
+    res['Content-Type'] = 'application/json'
+    res.status = 200
+    res.body = {  upload_url: "#{ENV.fetch('WT_API_URL')}/upload/#{SecureRandom.hex(9)}",
+                  part_number: part_number.to_i,
+                  upload_id: SecureRandom.hex(9),
+                  upload_expires_at: (Time.now + 5).to_i
+                }.to_json
+  end
+end
+
+class UploadPartServlet < HTTPServlet::AbstractServlet
+  def self.do_PUT(_req, res)
+    res['Content-Type'] = 'application/json'
+    res.status = 200
+  end
+end
+
+class TransferItemServlet < HTTPServlet::AbstractServlet
+  # this servlet is used for add_items_to_transfer functionality
+  def self.do_POST(req, res)
+    content = JSON.parse(req.body)
+    res['Content-Type'] = 'application/json'
+    res.status = 200
+    res.body = item_params(items: content["items"]).to_json
+  end
+
+  def self.item_params(items:)
+    items_array = []
+    items.each do |item|
+      items_array << {id: SecureRandom.hex(9),
+                      local_identifier: item['filename'][0..36],
+                      name: item['filename'],
+                      size: item['filesize'],
+                      meta:{
+                        multipart_parts: multipart_calc(item: item),
+                        multipart_id: SecureRandom.hex(9),
+                      },
+                      upload_url:"#{ENV.fetch('WT_API_URL')}/upload/#{SecureRandom.hex(9)}",
+                      upload_id: SecureRandom.hex(9),
+                      upload_expires_at: (Time.now + 5).to_i
+                    }
+    end
+    return items_array
+  end
+  def self.multipart_calc(item:)
+    parts = item['filesize'] / 6291456
+    parts == 0 ? 1 : parts
+  end
+end
+
+class UploadServlet < HTTPServlet::AbstractServlet
+  def do_PUT(req, res)
+    res['Content-Type'] = 'application/json'
+    res.status = 200
+  end
+end
+
+class CompleteItemServlet < HTTPServlet::AbstractServlet
+  def self.do_POST(_req, res)
+    res['Content-Type'] = 'application/json'
+    res.status = 202
+    res.body = {ok: true, message: 'File is marked as complete.'}.to_json
+  end
+end
+
+class TestServer
+  def self.start(log_file = nil, port = 9001)
+    new(log_file, port).start
+  end
+
+  def initialize(log_file = nil, port = 9001)
+    log_file ||= StringIO.new
+    log = WEBrick::BasicLog.new(log_file, WEBrick::BasicLog::WARN)
+
+    options = {
+      Port: port,
+      Logger: log,
+      AccessLog: [
+        [log, WEBrick::AccessLog::COMMON_LOG_FORMAT],
+        [log, WEBrick::AccessLog::REFERER_LOG_FORMAT]
+      ],
+      DocumentRoot: File.expand_path(__dir__),
+    }
+
+    @server = WEBrick::HTTPServer.new(options)
+    @server.mount('/v1/forbidden',     ForbiddenServlet)
+    @server.mount('/v1/authorize',  AuthServlet)
+    @server.mount_proc('/v1/transfers') do |req, res|
+      if req.path =~ /^(?=.*\bv1\b)(?=.*\btransfers\b)(?=.*\bitems\b).+/
+        TransferItemServlet.do_POST(req, res)
+      else
+        TransfersServlet.do_POST(req, res)
+      end
+    end
+    @server.mount_proc('/v1/files/') do |req, res|
+      if req.request_method == "PUT"
+        UploadPartServlet.do_PUT(req, res)
+      elsif req.request_method == "GET"
+        UploadUrlServlet.do_GET(req, res)
+      else
+        CompleteItemServlet.do_POST(req,res)
+      end
+    end
+    @server.mount('/upload', UploadServlet)
+  end
+
+  def start
+    trap('INT') {
+      begin
+        @server.shutdown unless @server.nil?
+      rescue Object => e
+        warn "Error #{__FILE__}:#{__LINE__}\n#{e.message}"
+      end
+    }
+
+    @thread = Thread.new { @server.start }
+    Thread.pass
+    self
+  end
+
+  def join
+    @thread.join if defined? @thread and @thread
+    self
+  end
+end

data/spec/wetransfer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe WeTransfer, :module do
+  it 'has a version number' do
+    expect(WeTransfer::VERSION).not_to be nil
+  end
+end

data/wetransfer.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wetransfer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wetransfer'
+  spec.version       = WeTransfer::VERSION
+  spec.authors       = ['Noah Berman', 'David Bosveld']
+  spec.email         = ['noah@wetransfer.com', 'david@wetransfer.com', 'developers@wetransfer.com']
+
+  spec.summary       = "A Ruby SDK for WeTransfer's Public API"
+  spec.description   = "Ruby bindings for using WeTransfer's Public API."
+  spec.homepage      = 'https://developers.wetransfer.com'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    # Make sure large fixture files are not packaged with the gem every time
+    f.match(%r{^spec/fixtures/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.13'
+  spec.add_dependency 'dotenv', '~> 2.2'
+  spec.add_dependency 'ks', '~> 0.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'wetransfer_style', '0.5.0'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: wetransfer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noah Berman
+- David Bosveld
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: wetransfer_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Ruby bindings for using WeTransfer's Public API.
+email:
+- noah@wetransfer.com
+- david@wetransfer.com
+- developers@wetransfer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wetransfer.rb
+- lib/wetransfer/client.rb
+- lib/wetransfer/connection.rb
+- lib/wetransfer/item.rb
+- lib/wetransfer/item_builder.rb
+- lib/wetransfer/transfer.rb
+- lib/wetransfer/transfer_builder.rb
+- lib/wetransfer/version.rb
+- spec/client_spec.rb
+- spec/connection_spec.rb
+- spec/item_builder_spec.rb
+- spec/spec_helper.rb
+- spec/test_server.rb
+- spec/wetransfer_spec.rb
+- wetransfer.gemspec
+homepage: https://developers.wetransfer.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A Ruby SDK for WeTransfer's Public API
+test_files: []