twitter-ads 5.0.0 → 5.1.0

data/lib/twitter-ads/http/ton_upload.rb

@@ -1,156 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
-
-module TwitterAds
-
-  # Specialized request class for TON API uploads.
-  class TONUpload
-
-    DEFAULT_DOMAIN = 'https://ton.twitter.com'.freeze # @api private
-    DEFAULT_RESOURCE = '/1.1/ton/bucket/'.freeze # @api private
-    DEFAULT_BUCKET = 'ta_partner'.freeze # @api private
-    DEFAULT_EXPIRE = (Time.now + 10 * 24 * 60 * 60).httpdate # @api private
-    DEFAULT_CHUNK_SIZE = 64 # @api private
-    SINGLE_UPLOAD_MAX = 1024 * 1024 * DEFAULT_CHUNK_SIZE # @api private
-    # target response time (ref. https://github.com/twitterdev/twitter-ruby-ads-sdk/pull/161)
-    RESPONSE_TIME_MAX = 5000 # @api private
-
-    private_constant :DEFAULT_DOMAIN,
-                     :DEFAULT_RESOURCE,
-                     :DEFAULT_BUCKET,
-                     :DEFAULT_EXPIRE,
-                     :DEFAULT_CHUNK_SIZE,
-                     :SINGLE_UPLOAD_MAX,
-                     :RESPONSE_TIME_MAX
-
-    # Creates a new TONUpload object instance.
-    #
-    # @example
-    #   request = TONUpload.new(client, '/path/to/file')
-    #
-    # @param client [Client] The Client object instance.
-    # @param file_path [String] The path to the file to be uploaded.
-    #
-    # @since 0.3.0
-    #
-    # @return [TONUpload] The TONUpload request instance.
-    def initialize(client, file_path, opts = {})
-      @file_path = File.expand_path(file_path)
-      unless File.exist?(file_path)
-        raise ArgumentError.new("Error! The specified file does not exist. (#{file_path})")
-      end
-
-      @file_size = File.size(@file_path)
-
-      @client    = client
-      @bucket    = opts.delete(:bucket) || DEFAULT_BUCKET
-      @options   = opts
-      self
-    end
-
-    # Executes the current TONUpload object.
-    #
-    # @example
-    #   request = TONUpload.new(client, '/path/to/file')
-    #   request.perform
-    #
-    # @since 0.3.0
-    #
-    # @return [String] The upload location provided by the TON API.
-    def perform
-      if @file_size < SINGLE_UPLOAD_MAX
-        resource = "#{DEFAULT_RESOURCE}#{@bucket}"
-        response = upload(resource, File.read(@file_path))
-        response.headers['location'][0]
-      else
-        response = init_chunked_upload
-        bytes_per_chunk_size = response.headers['x-ton-min-chunk-size'][0].to_i
-        location = response.headers['location'][0]
-
-        bytes_read = 0
-        chunk_bytes = bytes_per_chunk_size * DEFAULT_CHUNK_SIZE
-        File.open(@file_path) do |file|
-          while bytes = file.read(chunk_bytes)
-            bytes_start = bytes_read
-            bytes_read += bytes.size
-            upload_chunk(location, bytes, bytes_start, bytes_read) do |res|
-              # Determines the chunk bytes based on response times
-              response_time = res.headers['x-response-time'][0].to_f
-              response_based_chunk_size =
-                (DEFAULT_CHUNK_SIZE * (RESPONSE_TIME_MAX / response_time)).to_i
-              next_chunk_size = [DEFAULT_CHUNK_SIZE, [1, response_based_chunk_size].max].min
-              chunk_bytes = bytes_per_chunk_size * next_chunk_size
-            end
-          end
-        end
-
-        location.split('?')[0]
-      end
-    end
-
-    # Returns an inspection string for the current object instance.
-    #
-    # @since 0.3.0
-    #
-    # @return [String] The object instance detail.
-    def inspect
-      "#<#{self.class.name}:0x#{object_id} bucket=\"#{@bucket}\" file=\"#{@file_path}\">"
-    end
-
-    private
-
-    # performs a single chunk upload
-    def upload(resource, bytes)
-      headers = {
-        'x-ton-expires'  => DEFAULT_EXPIRE,
-        'content-length' => @file_size,
-        'content-type'   => content_type
-      }
-      TwitterAds::Request.new(
-        @client, :post, resource, domain: DEFAULT_DOMAIN, headers: headers, body: bytes).perform
-    end
-
-    # initialization for a multi-chunk upload
-    def init_chunked_upload
-      headers = {
-        'x-ton-content-type'   => content_type,
-        'x-ton-content-length' => @file_size,
-        'x-ton-expires'        => DEFAULT_EXPIRE,
-        'content-length'       => 0,
-        'content-type'         => content_type
-      }
-      resource = "#{DEFAULT_RESOURCE}#{@bucket}?resumable=true"
-      TwitterAds::Request.new(
-        @client, :post, resource, domain: DEFAULT_DOMAIN, headers: headers).perform
-    end
-
-    # uploads a single chunk of a multi-chunk upload
-    def upload_chunk(resource, bytes, bytes_start, bytes_read)
-      headers = {
-        'content-type'   => content_type,
-        'content-length' => bytes.size,
-        'content-range'  => "bytes #{bytes_start}-#{bytes_read - 1}/#{@file_size}"
-      }
-      response = TwitterAds::Request.new(
-        @client, :put, resource, domain: DEFAULT_DOMAIN, headers: headers, body: bytes).perform
-
-      yield(response)
-      response
-    end
-
-    def content_type
-      @content_type ||= begin
-        extension = File.extname(@file_path).downcase
-        if extension == '.csv'
-          'text/csv'
-        elsif extension == '.tsv'
-          'text/tab-separated-values'
-        else
-          'text/plain'
-        end
-      end
-    end
-
-  end
-
-end

data/spec/twitter-ads/http/ton_upload_spec.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
-
-require 'spec_helper'
-require 'tempfile'
-
-describe TwitterAds::TONUpload do
-  before(:each) do
-    stub_fixture(
-      :post, :no_content, "#{TON_API}/1.1/ton/bucket/#{bucket_name}",
-      headers: {
-        'location' => location_path
-      }
-    )
-    stub_fixture(
-      :post, :no_content, "#{TON_API}/1.1/ton/bucket/#{bucket_name}?resumable=true",
-      headers: {
-        'location' => "#{location_path}?resumable=true&resumeId=1234567",
-        'x-ton-min-chunk-size' => '1048576'
-      }
-    )
-  end
-  let(:bucket_name) { 'ta_partner' }
-  let(:location_path) { '/1.1/ton/data/ta_partner/123456789/tYfALUIK-F3ZMxj.txt' }
-
-  around(:each) do |example|
-    example.run
-    file.unlink
-  end
-  let!(:file) do
-    Tempfile.open(['', '.dat'], File.expand_path('../../../tmp/', __FILE__)) do |fp|
-      fp.tap { |f| f.write(SecureRandom.random_bytes(file_size)) }
-    end
-  end
-  let(:file_size) { 100 }
-
-  let(:ton_upload) { described_class.new(client, file_path) }
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-  let(:file_path) { file.path }
-
-  describe '#initialize' do
-
-    subject { ton_upload }
-    it { is_expected.to be_an_instance_of described_class }
-
-    context 'when the file path is invalid' do
-      let(:file_path) { '/invalid/file/path' }
-
-      it do
-        expect { subject }.to raise_error ArgumentError
-      end
-    end
-  end
-
-  describe '#perform' do
-    subject { ton_upload.perform }
-
-    it 'should call TwitterAds::Request#perform exactly once' do
-      expect_any_instance_of(TwitterAds::Request).to receive(:perform).once.and_call_original
-      subject
-    end
-
-    it { is_expected.to eq '/1.1/ton/data/ta_partner/123456789/tYfALUIK-F3ZMxj.txt' }
-
-    context 'when the file size is larger than 64MB' do
-      before(:each) do
-        allow(ton_upload).to receive(:upload_chunk)
-      end
-      let(:file_size) { 65 * 1024 * 1024 }
-
-      it { is_expected.to eq '/1.1/ton/data/ta_partner/123456789/tYfALUIK-F3ZMxj.txt' }
-      it 'should call TwitterAds::Request#perform exactly once' do
-        expect(ton_upload).to receive(:upload_chunk).at_least(:twice)
-        subject
-      end
-    end
-  end
-
-  describe '#inspect' do
-    subject { ton_upload.inspect }
-
-    it do
-      is_expected.to include(described_class.name)
-      is_expected.to include(ton_upload.object_id.to_s)
-      is_expected.to include(bucket_name)
-      is_expected.to include(file_path)
-    end
-  end
-end