Class: WeTransferClient

Inherits:
Object
  • Object
show all
Defined in:
lib/we_transfer_client.rb,
lib/we_transfer_client/version.rb

Defined Under Namespace

Classes: Error

Constant Summary collapse

NULL_LOGGER = 
Logger.new(nil)
MAGIC_PART_SIZE = 
6 * 1024 * 1024
VERSION = 
'0.4.4'

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, logger: NULL_LOGGER) ⇒ WeTransferClient

Returns a new instance of WeTransferClient.



22
23
24
25
26
27
 
# File 'lib/we_transfer_client.rb', line 22

def initialize(api_key:, logger: NULL_LOGGER)
  @api_url_base = 'https://dev.wetransfer.com'
  @api_key = api_key.to_str
  @bearer_token = nil
  @logger = logger
end

Instance Method Details

#auth_headers ⇒ Object 



119
120
121
122
123
124
125
 
# File 'lib/we_transfer_client.rb', line 119

def auth_headers
  raise 'No bearer token retrieved yet' unless @bearer_token
  {
    'X-API-Key' => @api_key,
    'Authorization' => ('Bearer %s' % @bearer_token),
  }
end

#authorize_if_no_bearer_token! ⇒ Object 



109
110
111
112
113
114
115
116
117
 
# File 'lib/we_transfer_client.rb', line 109

def authorize_if_no_bearer_token!
  return if @bearer_token
  response = faraday.post('/v1/authorize', '{}', 'Content-Type' => 'application/json', 'X-API-Key' => @api_key)
  ensure_ok_status!(response)
  @bearer_token = JSON.parse(response.body, symbolize_names: true)[:token]
  if @bearer_token.nil? || @bearer_token.empty?
    raise Error, "The authorization call returned #{response.body} and no usable :token key could be found there"
  end
end

#create_and_upload(xfer) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/we_transfer_client.rb', line 41

def create_and_upload(xfer)
  authorize_if_no_bearer_token!
  response = faraday.post(
    '/v1/transfers',
    JSON.pretty_generate(xfer.to_create_transfer_params),
    auth_headers.merge('Content-Type' => 'application/json')
  )
  ensure_ok_status!(response)
  create_transfer_response = JSON.parse(response.body, symbolize_names: true)

  remote_transfer = hash_to_struct(create_transfer_response, RemoteTransfer)
  remote_transfer.items = remote_transfer.items.map do |remote_item_hash|
    hash_to_struct(remote_item_hash, RemoteItem)
  end

  item_id_map = Hash[xfer.items.map(&:local_identifier).zip(xfer.items)]

  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),
      remote_item.fetch(:meta).fetch(:multipart_upload_id),
      local_item.io
    )

    complete_response = faraday.post(
      "/v1/files/#{remote_item_id}/uploads/complete",
      '{}',
      auth_headers.merge('Content-Type' => 'application/json')
    )
    ensure_ok_status!(complete_response)
  end
  remote_transfer
end

#create_empty_transfer(name:, description:) ⇒ Object 



36
37
38
39
 
# File 'lib/we_transfer_client.rb', line 36

def create_empty_transfer(name:, description:)
  future_transfer = FutureTransfer.new(name: name, description: description, items: [])
  create_and_upload(future_transfer)
end

#create_transfer(name:, description:) {|builder| ... } ⇒ Object

Yields:

  • (builder) 


29
30
31
32
33
34
 
# File 'lib/we_transfer_client.rb', line 29

def create_transfer(name:, description:)
  builder = TransferBuilder.new
  yield(builder)
  future_transfer = FutureTransfer.new(name: name, description: description, items: builder.items)
  create_and_upload(future_transfer)
end

#ensure_ok_status!(response) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/we_transfer_client.rb', line 127

def ensure_ok_status!(response)
  case response.status
  when 200..299
    nil
  when 400..499
    @logger.error { response.body }
    raise Error, "Response had a #{response.status} code, the server will not accept this request even if retried"
  when 500..504
    @logger.error { response.body }
    raise Error, "Response had a #{response.status} code, we could retry"
  else
    @logger.error { response.body }
    raise Error, "Response had a #{response.status} code, no idea what to do with that"
  end
end

#faraday ⇒ Object 



101
102
103
104
105
106
107
 
# File 'lib/we_transfer_client.rb', line 101

def faraday
  Faraday.new(@api_url_base) do |c|
    c.response :logger, @logger
    c.adapter Faraday.default_adapter
    c.headers = { 'User-Agent' => "WetransferRubySdk/#{WeTransferClient::VERSION} Ruby #{RUBY_VERSION}"}
  end
end

#hash_to_struct(hash, struct_class) ⇒ Object 



80
81
82
83
84
 
# File 'lib/we_transfer_client.rb', line 80

def hash_to_struct(hash, struct_class)
  members = struct_class.members
  struct_attrs = Hash[members.zip(hash.values_at(*members))]
  struct_class.new(**struct_attrs)
end

#put_io_in_parts(item_id, n_parts, multipart_id, io) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/we_transfer_client.rb', line 86

def put_io_in_parts(item_id, n_parts, multipart_id, io)
  chunk_size = MAGIC_PART_SIZE
  (1..n_parts).each do |part_n_one_based|
    response = faraday.get("/v1/files/#{item_id}/uploads/#{part_n_one_based}/#{multipart_id}", {}, auth_headers)
    ensure_ok_status!(response)
    response = JSON.parse(response.body, symbolize_names: true)

    upload_url = response.fetch(:upload_url)
    part_io = StringIO.new(io.read(chunk_size)) # needs a lens
    part_io.rewind
    response = faraday.put(upload_url, part_io, 'Content-Type' => 'binary/octet-stream', 'Content-Length' => part_io.size.to_s)
    ensure_ok_status!(response)
  end
end