Merge branch 'release/v1.1.2'

Author: genaromadrid

README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version][gem-version-image]][gem-version-url]
 [![Build Status][travis-image]][travis-url]
+[![Coverage Status][coveralls-image]][coveralls-url]
 [![security][security-image]][security-url]
 
 Ruby SDK for [Mifiel](https://www.mifiel.com) API.
@@ -78,6 +79,17 @@ Document methods:
   )
 ```
 
+- Save Document related files
+
+```ruby
+  # save the original file
+  document.save_file('path/to/save/file.pdf')
+  # save the signed file (original file + signatures page)
+  document.save_file_signed('path/to/save/file-signed.pdf')
+  # save the signed xml file
+  document.save_xml('path/to/save/xml.xml')
+```
+
 - Sign:
   + With a pre-created Certificate
 
@@ -146,7 +158,12 @@ Certificate methods:
 
 [gem-version-image]: https://badge.fury.io/rb/mifiel.svg
 [gem-version-url]: https://badge.fury.io/rb/mifiel
+
 [security-url]: https://hakiri.io/github/Mifiel/ruby-api-client/master
 [security-image]: https://hakiri.io/github/Mifiel/ruby-api-client/master.svg
+
 [travis-image]: https://travis-ci.org/Mifiel/ruby-api-client.svg?branch=master
 [travis-url]: https://travis-ci.org/Mifiel/ruby-api-client
+
+[coveralls-image]: https://coveralls.io/repos/github/Mifiel/ruby-api-client/badge.svg?branch=master
+[coveralls-url]: https://coveralls.io/github/Mifiel/ruby-api-client?branch=master

lib/mifiel/document.rb

@@ -17,7 +17,8 @@ def self.create(signatories:, file: nil, hash: nil, name: nil, callback_url: nil
         original_hash: hash,
         name: name
       }
-      process_request('/documents', :post, payload)
+      response = process_request('/documents', :post, payload)
+      JSON.load(response)
     end
 
     def request_signature(email, cc: nil)
@@ -26,7 +27,22 @@ def request_signature(email, cc: nil)
       Mifiel::Document._request("#{Mifiel.config.base_url}/documents/#{id}/request_signature", :post, params)
     end
 
-    def self.process_request(path, method, payload)
+    def save_file(path)
+      response = Mifiel::Document.process_request("/documents/#{id}/file", :get)
+      File.open(path, 'wb') { |file| file.write(response) }
+    end
+
+    def save_file_signed(path)
+      response = Mifiel::Document.process_request("/documents/#{id}/file_signed", :get)
+      File.open(path, 'wb') { |file| file.write(response) }
+    end
+
+    def save_xml(path)
+      response = Mifiel::Document.process_request("/documents/#{id}/xml", :get)
+      File.open(path, 'w') { |file| file.write(response) }
+    end
+
+    def self.process_request(path, method, payload=nil)
       path[0] = '' if path[0] == '/'
       rest_request = RestClient::Request.new(
         url: "#{Mifiel.config.base_url}/#{path}",
@@ -35,7 +51,7 @@ def self.process_request(path, method, payload)
         ssl_version: 'SSLv23'
       )
       req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
-      JSON.load(req.execute)
+      req.execute
     end
 
     def self.build_signatories(signatories)

lib/mifiel/version.rb

@@ -1,3 +1,3 @@
 module Mifiel
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
 end

spec/mifiel/document_spec.rb

@@ -19,39 +19,72 @@
     end
   end
 
-  describe '#request_signature' do
+  describe 'working with a document' do
     let!(:document) { Mifiel::Document.all.first }
-    let!(:error_body) { { errors: ['some error'] }.to_json }
 
-    it '' do
-      expect do
-        document.request_signature('[email protected]')
-      end.not_to raise_error
-    end
+    describe '#save_file' do
+      let!(:path) {'tmp/the-file.pdf' }
+      before { File.unlink(path) if File.exist?(path)}
 
-    context 'when bad request' do
-      before do
-        url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
-        stub_request(:post, url).to_return(body: error_body, status: 404)
+      it 'should get the file' do
+        document.save_file(path)
+        expect(File.exist?(path)).to be true
       end
+    end
 
-      it '' do
-        expect do
-          document.request_signature('[email protected]')
-        end.to raise_error(Mifiel::BadRequestError)
+    describe '#save_file_signed' do
+      let!(:path) {'tmp/the-file-signed.pdf' }
+      before { File.unlink(path) if File.exist?(path)}
+
+      it 'should get the file' do
+        document.save_file_signed(path)
+        expect(File.exist?(path)).to be true
       end
     end
 
-    context 'when server error' do
-      before do
-        url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
-        stub_request(:post, url).to_return(body: error_body, status: 500)
+    describe '#save_xml' do
+      let!(:path) {'tmp/the-xml.xml' }
+      before { File.unlink(path) if File.exist?(path)}
+
+      it 'should get the file' do
+        document.save_xml(path)
+        expect(File.exist?(path)).to be true
       end
+    end
+
+    describe '#request_signature' do
+      let!(:error_body) { { errors: ['some error'] }.to_json }
 
       it '' do
         expect do
           document.request_signature('[email protected]')
-        end.to raise_error(Mifiel::ServerError)
+        end.not_to raise_error
+      end
+
+      context 'when bad request' do
+        before do
+          url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
+          stub_request(:post, url).to_return(body: error_body, status: 404)
+        end
+
+        it '' do
+          expect do
+            document.request_signature('[email protected]')
+          end.to raise_error(Mifiel::BadRequestError)
+        end
+      end
+
+      context 'when server error' do
+        before do
+          url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
+          stub_request(:post, url).to_return(body: error_body, status: 500)
+        end
+
+        it '' do
+          expect do
+            document.request_signature('[email protected]')
+          end.to raise_error(Mifiel::ServerError)
+        end
       end
     end
   end

spec/support/fake_mifiel.rb

@@ -45,6 +45,21 @@ class FakeMifiel < Sinatra::Base
     ).to_json
   end
 
+  get '/api/v1/documents/:id/file' do
+    status 200
+    'some-pdf-formatted-string'
+  end
+
+  get '/api/v1/documents/:id/file_signed' do
+    status 200
+    'some-pdf-formatted-string'
+  end
+
+  get '/api/v1/documents/:id/xml' do
+    status 200
+    '<some><xml>contents</xml></some>'
+  end
+
   post '/api/v1/documents/:id/request_signature' do
     content_type :json
     status 200