hellosign-ruby-sdk 3.0.18 → 3.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29643cd2407c931729cfa222edf5bda0adb6a6bb
-  data.tar.gz: cb307966b0355ef27cc475ffeca1b203a6d80d5c
+  metadata.gz: c422e4abbd97f92563383ee0e5355f4485c4b297
+  data.tar.gz: eedf437c54a440c11a561484b2062325a0f9ac95
 SHA512:
-  metadata.gz: 514b1b19d22bd8402a7d1724920bc0bb3b61b563da9a18f519057e0dabcc50735f37be28a23174dd03dfb3a6de78dbaa0f09b631f57c1a85d2431891f552b994
-  data.tar.gz: 97599fb900e28a83fef212cd34922d430d5f0a6bdc07b7cafa0793f14463c81b4325d530ac925768c958aef44f3707f96e155a3a2f878b42c13caa2d7b2f0d29
+  metadata.gz: 17b9f71f60fe5e8533d83654289582cf46988cb92bf976e97733048078747247e662ce4fa1bbbef4ffe0f90456f44e61c506e65bce32f25f32153785fe3e831d
+  data.tar.gz: 93188013bbcb4a47dcca7886eb3ec377c38c190404a4e6b069acc700c070c5eb5ff196f7576d8d1defd8c096828bd77bb98f0f1b28b1a0d696b76a46428a2fb6

data/README.md

@@ -48,6 +48,12 @@ If you need to authenticate for multiple users and you want a separated client f
 client2 = HelloSign::Client.new :api_key => 'your_user_api_key'
 user_account = client2.get_account
 ```
+### Specifying files
+
+When using request endpoints that send files, such as a signature request, you can specify files either as
+1. A string representing the path
+2. A Ruby File Object (File.open, then assign to a variable)
+3. A Rails ActionDispatch::Http::UploadedFile
 
 ##Testing
 
@@ -56,6 +62,29 @@ from the root of your project run <code>rake spec</code>.
 
 ## Additional notes
 
+## Warnings
+Any warnings returned from the API can be accessed by using the 'warnings' accessor on a returned object or list:
+
+````ruby
+my_signature_requests = client.get_signature_requests
+puts my_signature_requests.warnings
+````
+
+and will give output of warnings in the following format (as an array of hashes):
+
+````
+[
+    [0] {
+         "warning_msg" => "Parameter hodor was ignored. Hodor.",
+        "warning_name" => "parameter_ignored"
+    },
+    [1] {
+         "warning_msg" => "Email address sirjorah@targarian.org is unconfirmed. Please pledge your allegiance to the queen first.",
+        "warning_name" => "unconfirmed"
+    }
+]
+````
+
 ### Local callbacks
 We do not allow app callbacks (event or OAuth) to be set to localhost. However it is still possible to test callbacks against a local server. Tunneling services such as ngrok (http://ngrok.com) can help you set this up.
 

data/hellosign-ruby-sdk.gemspec

@@ -2,9 +2,9 @@
 
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -49,4 +49,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock'
   spec.add_runtime_dependency 'faraday'
   spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'mime-types'
 end

data/lib/hello_sign/client.rb

@@ -24,10 +24,13 @@
 
 require 'faraday'
 require 'multi_json'
+require 'mime/types'
 require 'hello_sign/error'
 require 'hello_sign/configuration'
 require 'hello_sign/resource'
 require 'hello_sign/api'
+require 'openssl'
+ OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 require 'logger'
 
 module HelloSign
@@ -187,14 +190,44 @@ module HelloSign
       "Message: #{response.body}"
     end
 
+    def MIMEfromName(name)
+      parts = name.split('.')
+      #default to pdf if no extension
+      if parts.length < 2
+        return 'application/pdf'
+      end
+      extension = parts[-1]
+      types = MIME::Types.type_for(extension)
+      types[0]
+    end
+
+    def MIMEfromIO(file)
+      begin
+        path = File.path file
+        MIMEfromName path
+      # in case of error in type detection, return default type
+      rescue
+        return 'application/pdf'
+      end
+    end
+
     def prepare_files(opts)
       if opts[:files]
         opts[:files].each_with_index do |file, index|
           if file.is_a? String
-            opts[:"file[#{index}]"] = Faraday::UploadIO.new(StringIO.new(file), 'application/pdf')
+            if File.file?(file)
+              mime_type = MIMEfromName file
+              opts[:"file[#{index}]"] = Faraday::UploadIO.new(file, mime_type)
+            else
+              raise HelloSign::Error::FileNotFound.new "#{file} was not found on the filesystem"
+            end
+          elsif file.is_a? File
+            mime_type = MIMEfromIO file
+            opts[:"file[#{index}]"] = Faraday::UploadIO.new(file, mime_type)
           elsif defined? ActionDispatch::Http::UploadedFile
             if file.is_a? ActionDispatch::Http::UploadedFile
-              opts[:"file[#{index}]"] = UploadIO.new(file.tempfile, 'application/pdf')
+              mime_type MIMEfromIO file
+              opts[:"file[#{index}]"] = UploadIO.new(file.tempfile, mime_type)
             end
           else
             raise HelloSign::Error::NotSupportedType.new "#{file.class} is not a supported. Must be a string or ActionDispatch::Http::UploadedFile"

data/lib/hello_sign/error.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -72,6 +72,9 @@ module HelloSign
     # Raised when API endpoint returns the HTTP status code 503.
     class NotSupportedType < Error; end
 
+    # Raised when a file attempted to be sent in a request doesn't exist
+    class FileNotFound < Error; end
+
     # Raised when API endpoint returns error which is not defined in sdk.
     class UnknownError < Error; end
   end

data/lib/hello_sign/version.rb

@@ -23,5 +23,5 @@
 #
 
 module HelloSign
-  VERSION = '3.0.18'
+  VERSION = '3.0.19'
 end

data/spec/scenarios/uploads_spec.rb

@@ -5,15 +5,7 @@ describe 'Uploading File' do
     before { stub_post('/signature_request/create_embedded', 'signature_request') }
 
     it 'works with simple pdf' do
-      expect(HelloSign.create_embedded_signature_request({files: [load_file('empty.pdf')]}))
-    end
-
-    it 'works with null byte string' do
-      expect(HelloSign.create_embedded_signature_request({files: ["\0"]}))
-    end
-
-    it 'works with empty string' do
-      expect(HelloSign.create_embedded_signature_request({files: ['']}))
+      expect(HelloSign.create_embedded_signature_request({files: ['spec/fixtures/nda.pdf']}))
     end
   end
 
@@ -21,15 +13,7 @@ describe 'Uploading File' do
     before { stub_post('/unclaimed_draft/create', 'unclaimed_draft') }
 
     it 'works with simple pdf' do
-      expect(HelloSign.create_unclaimed_draft({files: [load_file('empty.pdf')]}))
-    end
-
-    it 'works with null byte string' do
-      expect(HelloSign.create_unclaimed_draft({files: ["\0"]}))
-    end
-
-    it 'works with empty string' do
-      expect(HelloSign.create_unclaimed_draft({files: ['']}))
+      expect(HelloSign.create_unclaimed_draft({files: ['spec/fixtures/nda.pdf']}))
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.18
+  version: 3.0.19
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email: support@hellosign.com
 executables: []
@@ -137,6 +151,7 @@ files:
 - spec/fixtures/empty.pdf
 - spec/fixtures/error.json
 - spec/fixtures/file.json
+- spec/fixtures/nda.pdf
 - spec/fixtures/signature_request.json
 - spec/fixtures/signature_requests.json
 - spec/fixtures/team.json
@@ -186,6 +201,7 @@ test_files:
 - spec/fixtures/empty.pdf
 - spec/fixtures/error.json
 - spec/fixtures/file.json
+- spec/fixtures/nda.pdf
 - spec/fixtures/signature_request.json
 - spec/fixtures/signature_requests.json
 - spec/fixtures/team.json