transloadit 1.2.0 → 2.0.0

data/test/fixtures/cassettes/submit_assembly.yml

@@ -1,43 +1,8 @@
 ---
 http_interactions:
-- request:
-    method: get
-    uri: http://api2.transloadit.com/instances/bored
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept:
-      - ! '*/*; q=0.5, application/xml'
-      Accept-Encoding:
-      - gzip, deflate
-      User-Agent:
-      - Transloadit Ruby SDK 0.0.1
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Headers:
-      - X-Requested-With, Content-Type, Accept, Content-Length
-      Access-Control-Allow-Methods:
-      - POST, GET, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Origin:
-      - ! '*'
-      Content-Type:
-      - text/plain
-      Content-Length:
-      - '98'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: ! '{"ok":"BORED_INSTANCE_FOUND","host":"vivian.transloadit.com","api2_host":"vivian.transloadit.com"}'
-    http_version: '1.1'
-  recorded_at: Fri, 08 Mar 2013 15:13:10 GMT
 - request:
     method: post
-    uri: http://vivian.transloadit.com/assemblies
+    uri: http://api2.transloadit.com/assemblies
     body:
       encoding: UTF-8
       string: params=%7B%22steps%22%3A%7B%22a479db2c601661d8f914caf9cf258c0b%22%3A%7B%22robot%22%3A%22%2Fvideo%2Fthumbs%22%7D%7D%2C%22redirect_url%22%3A%22http%3A%2F%2Ffoo.bar%2F%22%2C%22auth%22%3A%7B%22key%22%3A%22%22%7D%2C%22file_0%22%3A%22%23%3CFile%3A0x00000100c63738%3E%22%7D

data/test/fixtures/cassettes/update_template.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://api2.transloadit.com/templates/55c965a063a311e6ba2d379ef10b28f7
+    body:
+      encoding: UTF-8
+      string: params=%7B%22auth%22%3A%7B%22key%22%3A%22%22%7D%7D
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Transloadit Ruby SDK 1.2.0
+      Content-Length:
+      - '50'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Host:
+      - api2.transloadit.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 24 Aug 2016 09:58:34 GMT
+      Content-Length:
+      - '75'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":"TEMPLATE_UPDATED", "template_id":"55c965a063a311e6ba2d379ef10b28f7"}'
+    http_version: 
+  recorded_at: Wed, 24 Aug 2016 09:58:33 GMT
+recorded_with: VCR 3.0.3

data/test/test_helper.rb

@@ -15,3 +15,7 @@ VCR.configure do |c|
   c.default_cassette_options = { :record => :none }
   c.hook_into :webmock
 end
+
+def values_from_post_body(body)
+  Addressable::URI.parse('?' + URI.decode(body)).query_values
+end

data/test/unit/test_transloadit.rb

@@ -65,7 +65,7 @@ describe Transloadit do
       step.options.must_equal :width => 320
     end
 
-    it 'must create assemblies' do
+    it 'must create assembly api instances' do
       step     = @transloadit.step(nil, nil)
       assembly = @transloadit.assembly :steps => step
 
@@ -83,6 +83,19 @@ describe Transloadit do
       assembly.steps.must_equal steps.inject({}) {|h,s| h.merge s }
     end
 
+    it 'must get user billing report' do
+      VCR.use_cassette 'fetch_billing' do
+        bill = Transloadit.new(:key => '').bill(9, 2016)
+        bill['ok'].must_equal 'BILL_FOUND'
+        bill['invoice_id'].must_equal '76fe5df1c93a0a530f3e583805cf98b4'
+      end
+    end
+
+    it 'must create template api instances' do
+      template = @transloadit.template
+      template.must_be_kind_of Transloadit::Template
+    end
+
     it 'must inspect like a hash' do
       @transloadit.inspect.must_equal @transloadit.to_hash.inspect
     end

data/test/unit/transloadit/test_api.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+describe Transloadit::ApiModel do
+  let(:foo) { 'foo' }
+  let(:bar) { 'bar' }
+  let(:transloadit) { Transloadit.new(:key => '') }
+
+  let(:api) { Transloadit::ApiModel.new(
+    transloadit,
+    :foo => foo,
+    :bar => bar
+  )}
+
+  it 'must allow initialization' do
+    Transloadit::ApiModel.new(transloadit).
+      must_be_kind_of Transloadit::ApiModel
+
+    Transloadit::Template.new(transloadit).
+      must_be_kind_of Transloadit::Template
+  end
+
+  describe 'when initialized' do
+    it 'must store a pointer to the transloadit instance' do
+      api.transloadit.must_equal transloadit
+    end
+
+    it 'must remember the options passed' do
+      api.options.must_equal(
+        :foo => foo,
+        :bar => bar
+      )
+    end
+
+    it 'must inspect like a hash' do
+      api.inspect.must_equal api.to_hash.inspect
+    end
+
+    it 'must produce Transloadit-compatible hash output' do
+      api.to_hash.must_equal(
+        :auth => transloadit.to_hash,
+        :foo  => foo,
+        :bar  => bar
+      )
+    end
+
+    it 'must produce Transloadit-compatible JSON output' do
+      api.to_json.must_equal MultiJson.dump(api.to_hash)
+    end
+  end
+end

data/test/unit/transloadit/test_assembly.rb

@@ -5,9 +5,8 @@ describe Transloadit::Assembly do
     @transloadit = Transloadit.new(:key => '')
   end
 
-  it 'must allow initialization' do
-    Transloadit::Assembly.new(@transloadit).
-      must_be_kind_of Transloadit::Assembly
+  it 'must inherit from Transloadit::ApiModel class' do
+    (Transloadit::Assembly < Transloadit::ApiModel).must_equal true
   end
 
   describe 'when initialized' do
@@ -20,17 +19,6 @@ describe Transloadit::Assembly do
         :redirect_url => @redirect
     end
 
-    it 'must store a pointer to the transloadit instance' do
-      @assembly.transloadit.must_equal @transloadit
-    end
-
-    it 'must remember the options passed' do
-      @assembly.options.must_equal(
-        :steps        => @step,
-        :redirect_url => @redirect
-      )
-    end
-
     it 'must wrap its step in a hash' do
       @assembly.steps.must_equal @step.to_hash
     end
@@ -45,10 +33,6 @@ describe Transloadit::Assembly do
       @assembly.steps.must_equal :foo => 1
     end
 
-    it 'must inspect like a hash' do
-      @assembly.inspect.must_equal @assembly.to_hash.inspect
-    end
-
     it 'must produce Transloadit-compatible hash output' do
       @assembly.to_hash.must_equal(
         :auth         => @transloadit.to_hash,
@@ -57,13 +41,9 @@ describe Transloadit::Assembly do
       )
     end
 
-    it 'must produce Transloadit-compatible JSON output' do
-      @assembly.to_json.must_equal MultiJson.dump(@assembly.to_hash)
-    end
-
     it 'must submit files for upload' do
       VCR.use_cassette 'submit_assembly' do
-        response = @assembly.submit! open('lib/transloadit/version.rb')
+        response = @assembly.create! open('lib/transloadit/version.rb')
         response.code.must_equal 302
         response.headers[:location].must_match %r{^http://foo.bar/}
       end
@@ -73,7 +53,9 @@ describe Transloadit::Assembly do
       include WebMock::API
 
       before do
-        stub_request(:post, 'jane.transloadit.com/assemblies')
+        WebMock.reset!
+        stub_request(:post, 'api2.transloadit.com/assemblies')
+          .to_return(body: '{"ok":"ASSEMBLY_COMPLETED"}')
       end
 
       after do
@@ -81,30 +63,92 @@ describe Transloadit::Assembly do
       end
 
       it 'must allow to send a template id along' do
-        VCR.use_cassette 'fetch_bored' do
-          Transloadit::Assembly.new(
-            @transloadit,
-            :template_id => 'TEMPLATE_ID'
-          ).submit!
-
-          assert_requested(:post, 'jane.transloadit.com/assemblies') do |req|
-            values = values_from_post_body(req.body)
-            MultiJson.load(values['params'])['template_id'].must_equal 'TEMPLATE_ID'
-          end
+        Transloadit::Assembly.new(
+          @transloadit,
+          :template_id => 'TEMPLATE_ID'
+        ).create!
+
+        assert_requested(:post, 'api2.transloadit.com/assemblies') do |req|
+          values = values_from_post_body(req.body)
+          MultiJson.load(values['params'])['template_id'].must_equal 'TEMPLATE_ID'
         end
       end
 
       it 'must allow to send the fields hash' do
-        VCR.use_cassette 'fetch_bored' do
-          Transloadit::Assembly.new(
-            @transloadit,
-            :fields => {:tag => 'ninja-cat'}
-          ).submit!
-
-          assert_requested(:post, 'jane.transloadit.com/assemblies') do |req|
-            values = values_from_post_body(req.body)
-            values['tag'].must_equal 'ninja-cat'
-            MultiJson.load(values['params'])['fields']['tag'].must_equal 'ninja-cat'
+        Transloadit::Assembly.new(
+          @transloadit,
+          :fields => {:tag => 'ninja-cat'}
+        ).create!
+
+        assert_requested(:post, 'api2.transloadit.com/assemblies') do |req|
+          values = values_from_post_body(req.body)
+          values['tag'].must_equal 'ninja-cat'
+          MultiJson.load(values['params'])['fields']['tag'].must_equal 'ninja-cat'
+        end
+      end
+
+      it 'must allow steps through the create! method' do
+        Transloadit::Assembly.new(@transloadit).create!(
+          { :steps => @transloadit.step('thumbs', '/video/thumbs') }
+        )
+
+        assert_requested(:post, 'api2.transloadit.com/assemblies') do |req|
+          values = values_from_post_body(req.body)
+          MultiJson.load(values['params'])['steps'].must_equal({'thumbs'=>{'robot'=>'/video/thumbs'}})
+        end
+      end
+
+      it 'must allow steps passed through the create! method override steps previously set' do
+        @assembly.create!({ :steps => @transloadit.step('resize', '/image/resize') })
+
+        assert_requested(:post, 'api2.transloadit.com/assemblies') do |req|
+          values = values_from_post_body(req.body)
+          MultiJson.load(values['params'])['steps'].must_equal({"resize"=>{'robot'=>'/image/resize'}})
+        end
+      end
+    end
+
+    describe 'when using the "submit!" method' do
+
+      it 'must call the create! method with the same parameters' do
+        VCR.use_cassette 'submit_assembly' do
+          file = open('lib/transloadit/version.rb')
+          mocker = MiniTest::Mock.new
+          mocker.expect :call, nil, [file]
+          @assembly.stub :create!, mocker do
+            @assembly.submit!(file)
+          end
+          mocker.verify
+        end
+      end
+    end
+
+    describe 'when rate limit is reached' do
+
+      it 'must output a warning and retry for a successful request' do
+        VCR.use_cassette 'rate_limit_succeed' do
+          _, warning = capture_io do
+            response = @assembly.create! open('lib/transloadit/version.rb')
+            response['ok'].must_equal 'ASSEMBLY_COMPLETED'
+          end
+          warning.must_equal "Rate limit reached. Waiting for 0 seconds before retrying.\n"
+        end
+      end
+
+      it 'must retry only the number of times specified' do
+        @assembly.options[:tries] = 1
+
+        VCR.use_cassette 'rate_limit_succeed' do
+          assert_raises Transloadit::Exception::RateLimitReached do
+            response = @assembly.create! open('lib/transloadit/version.rb')
+          end
+        end
+      end
+
+      it 'must raise RateLimitReached exception after multiple retries request' do
+        VCR.use_cassette 'rate_limit_fail' do
+          assert_raises Transloadit::Exception::RateLimitReached do
+            response = @assembly.create! open('lib/transloadit/version.rb')
           end
         end
       end
@@ -125,8 +169,95 @@ describe Transloadit::Assembly do
       @assembly.to_hash[:steps].keys.must_include @thumbs.name
     end
   end
-end
 
-def values_from_post_body(body)
-  Addressable::URI.parse('?' + URI.decode(body)).query_values
+  describe 'using assembly API methods' do
+    include WebMock::API
+
+    before do
+      WebMock.reset!
+      @assembly = Transloadit::Assembly.new @transloadit
+    end
+
+    describe 'when fetching all assemblies' do
+
+      it 'must perform GET request to /assemblies' do
+        stub = stub_request(:get, 'api2.transloadit.com/assemblies?params=%7B%22auth%22:%7B%22key%22:%22%22%7D%7D')
+        @assembly.list
+
+        assert_requested(stub)
+      end
+
+      it 'must return a list of items' do
+        VCR.use_cassette 'fetch_assemblies' do
+          response = @assembly.list
+
+          response['items'].must_equal []
+          response['count'].must_equal 0
+        end
+      end
+    end
+
+    describe 'when fetching single assembly' do
+
+      it 'must perform GET request to /assemblies/[id]' do
+        stub = stub_request(:get, 'api2.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4')
+        @assembly.get '76fe5df1c93a0a530f3e583805cf98b4'
+
+        assert_requested(stub)
+      end
+
+      it 'must get assembly with specified id' do
+        VCR.use_cassette 'fetch_assembly_ok' do
+          response = @assembly.get '76fe5df1c93a0a530f3e583805cf98b4'
+          response['assembly_id'].must_equal '76fe5df1c93a0a530f3e583805cf98b4'
+        end
+      end
+    end
+
+    describe 'when fetching assembly notifications' do
+
+      it 'must perform GET request to /assembly_notifications' do
+        stub = stub_request(
+          :get,
+          'api2.transloadit.com/assembly_notifications?params=%7B%22auth%22:%7B%22key%22:%22%22%7D%7D'
+        )
+        @assembly.get_notifications
+
+        assert_requested(stub)
+      end
+
+      it 'must return a list of items' do
+        VCR.use_cassette 'fetch_assembly_notifications' do
+          response = @assembly.get_notifications
+
+          response['items'].must_equal []
+          response['count'].must_equal 0
+        end
+      end
+    end
+
+    describe 'when replaying assembly' do
+
+      it 'must perform POST request to assemblies/[id]/replay' do
+        VCR.use_cassette 'replay_assembly' do
+          response = @assembly.replay '55c965a063a311e6ba2d379ef10b28f7'
+
+          response['ok'].must_equal 'ASSEMBLY_REPLAYING'
+          response['assembly_id'].must_equal 'b8590300650211e6b826d727b2cfd9ce'
+        end
+      end
+    end
+
+    describe 'when replaying assembly notification' do
+
+      it 'must replay notification of sepcified assembly' do
+        VCR.use_cassette 'replay_assembly_notification' do
+          response = @assembly.replay_notification '2ea5d21063ad11e6bc93e53395ce4e7d'
+
+          response['ok'].must_equal 'ASSEMBLY_NOTIFICATION_REPLAYED'
+          response['assembly_id'].must_equal '2ea5d21063ad11e6bc93e53395ce4e7d'
+        end
+      end
+    end
+  end
 end