Integration specs

Author: stevelacey

README.md

@@ -70,7 +70,7 @@ You can use these URLs to download output files:
 ```rb
 exported_url_task_id = "84e872fc-d823-4363-baab-eade2e05ee54"
 task = cloudconvert.tasks.wait(exported_url_task_id) # Wait for job completion
-file = task.result.files[0]
+file = task.result.files.first
 export = cloudconvert.download(file.url)
 ```
 
@@ -102,7 +102,7 @@ job = cloudconvert.jobs.create({
 After you've created a `import/upload` task, you can upload a file:
 
 ```rb
-upload_task = job.tasks[0]
+upload_task = job.tasks.where(operation: "import/upload").first
 
 response = cloudconvert.tasks.upload("/path/to/sample.pdf", upload_task)
 

cloudconvert.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json"
   spec.add_dependency "memoizable", "~> 0.4.0"
   spec.add_dependency "mimemagic", "~> 0.3.5"
+  spec.add_dependency "multi_xml"
   spec.add_dependency "openssl"
   spec.add_dependency "ostruct"
   spec.add_dependency "schemacop", "~> 2.4"

lib/cloudconvert.rb

@@ -25,6 +25,7 @@
 require "cloudconvert/resources/tasks"
 require "cloudconvert/resources/users"
 require "cloudconvert/task"
+require "cloudconvert/upload"
 require "cloudconvert/user"
 require "cloudconvert/version"
 require "cloudconvert/webhook"

lib/cloudconvert/base.rb

@@ -99,7 +99,7 @@ def define_collection_method(key, klass)
         define_method(key) do
           collection = @attrs[key] || []
           entity = CloudConvert.const_get(klass)
-          collection.map { |item| entity.new(item) }
+          Collection.new collection.map { |item| entity.new(item) }
         end
         memoize(key)
       end

lib/cloudconvert/client.rb

@@ -92,6 +92,7 @@ def connection
         f.request :json
         f.request :multipart
         f.use CloudConvert::Middleware::ParseJson, content_type: /\bjson$/
+        f.use FaradayMiddleware::ParseXml, content_type: /\bxml$/
       end
     end
 

lib/cloudconvert/entity.rb

@@ -1,5 +1,7 @@
 module CloudConvert
   class Entity < Base
+    attr_reader :id
+
     include Equalizer.new(:id)
 
     class << self

lib/cloudconvert/resources/tasks.rb

@@ -56,7 +56,7 @@ def wait(id)
 
       # @param file [File, String, IO] Either a String filename to a local file or an open IO object.
       # @param task [Task] The "import/upload" Task to upload the file to.
-      # @return [Response]
+      # @return [Upload]
       def upload(file, task)
         unless task.operation == "import/upload"
           raise ArgumentError.new("The task operation is not import/upload")
@@ -68,10 +68,12 @@ def upload(file, task)
 
         file = File.new(file) unless file.is_a? File
 
-        client.post(task.result.form.url, task.result.form.parameters.to_h.merge(file: file)) do |request|
+        response = client.post(task.result.form.url, task.result.form.parameters.to_h.merge(file: file)) do |request|
           request.headers.delete("Authorization")
           request.headers["Content-Type"] = "multipart/form-data"
         end
+
+        Upload.new Hash[*response["PostResponse"].flat_map { |k, v| [k.downcase.to_sym, v] }]
       end
     end
   end

lib/cloudconvert/upload.rb

@@ -0,0 +1,6 @@
+module CloudConvert
+  class Upload < Base
+    # @return [String]
+    attr_reader :bucket, :etag, :key, :location
+  end
+end

spec/client_spec.rb

@@ -2,13 +2,13 @@
   API_KEY_ATTR = "api key from attrs"
   API_KEY_ENV = "api key from env"
 
-  subject do
+  let(:cloudconvert) do
     CloudConvert::Client.new(api_key: API_KEY_ATTR)
   end
 
   describe ".new" do
     it "reads the api key out of attrs" do
-      expect(subject.api_key).to eq API_KEY_ATTR
+      expect(cloudconvert.api_key).to eq API_KEY_ATTR
     end
 
     it "reads the api key out of the env variable" do
@@ -19,7 +19,7 @@
 
     it "prefers the api key out of attrs" do
       with_env CLOUDCONVERT_API_KEY: API_KEY_ENV do
-        expect(subject.api_key).to eq API_KEY_ATTR
+        expect(cloudconvert.api_key).to eq API_KEY_ATTR
       end
     end
 
@@ -33,11 +33,11 @@
 
     it "reads the sandbox bool out of the env variable" do
       with_env CLOUDCONVERT_SANDBOX: "true" do
-        expect(subject.sandbox).to eq true
+        expect(cloudconvert.sandbox).to eq true
       end
 
       with_env CLOUDCONVERT_SANDBOX: "TRUE" do
-        expect(subject.sandbox).to eq true
+        expect(cloudconvert.sandbox).to eq true
       end
     end
 
@@ -52,32 +52,32 @@
     end
 
     it "defaults to false when no sandbox bool is supplied" do
-      expect(subject.sandbox).to be false
+      expect(cloudconvert.sandbox).to be false
     end
   end
 
   describe "#download" do
     it "downloads the file and returns a tempfile" do
       stub_request(:get, "https://storage.cloudconvert.com/file.mp4").to_return(body: "video content")
-      expect(subject.download("https://storage.cloudconvert.com/file.mp4")).to be_a Tempfile
+      expect(cloudconvert.download("https://storage.cloudconvert.com/file.mp4")).to be_a Tempfile
     end
   end
 
   describe "#jobs" do
     it "returns jobs resource" do
-      expect(subject.jobs).to be_a CloudConvert::Resources::Jobs
+      expect(cloudconvert.jobs).to be_a CloudConvert::Resources::Jobs
     end
   end
 
   describe "#tasks" do
     it "returns tasks resource" do
-      expect(subject.tasks).to be_a CloudConvert::Resources::Tasks
+      expect(cloudconvert.tasks).to be_a CloudConvert::Resources::Tasks
     end
   end
 
   describe "#users" do
     it "returns users resource" do
-      expect(subject.users).to be_a CloudConvert::Resources::Users
+      expect(cloudconvert.users).to be_a CloudConvert::Resources::Users
     end
   end
 end

spec/collection_spec.rb

@@ -0,0 +1,30 @@
+describe CloudConvert::Collection do
+  let(:collection) do
+    CloudConvert::Collection.new [import_task, export_task]
+  end
+
+  let(:import_task) do
+    CloudConvert::Task.new(name: "import/url", status: :finished)
+  end
+
+  let(:export_task) do
+    CloudConvert::Task.new(name: "export/url", status: :finished)
+  end
+
+  describe "#where" do
+    it "should filter results" do
+      expect(collection.where(name: "import/url").first).to be import_task
+      expect(collection.where(name: "import/url").count).to be 1
+      expect(collection.where(name: "export/url").first).to be export_task
+      expect(collection.where(name: "export/url").count).to be 1
+      expect(collection.where(name: "import/url", status: :finished).first).to be import_task
+      expect(collection.where(name: "import/url", status: :finished).count).to be 1
+      expect(collection.where(name: "export/url", status: :finished).first).to be export_task
+      expect(collection.where(name: "export/url", status: :finished).count).to be 1
+      expect(collection.where(name: "import/url", status: :waiting).first).to be nil
+      expect(collection.where(name: "import/url", status: :waiting).count).to be 0
+      expect(collection.where(name: "export/url", status: :waiting).first).to be nil
+      expect(collection.where(name: "export/url", status: :waiting).count).to be 0
+    end
+  end
+end