interfax 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d294e821fce170d8c40efeca152aa0f490eb567e
-  data.tar.gz: 099bd020ef2e65f9673475cbeec4868ceae70b44
+  metadata.gz: 55720a871ff442165ff9c12c3c1c8b51bd4cab07
+  data.tar.gz: c36611237b5d777b2526e96261cad0519d679a22
 SHA512:
-  metadata.gz: 7d2deadcb67d1c753df38456224cbf06ffe6eddb35e7d1481b9693d67c1f7d5f6ee2a1c27437bd381ed1ca23252bb35be0e46f03dcc43c4f1dfd95ee07c54dab
-  data.tar.gz: d32542d6f649c3ccdf497fa229e6ee43ed28532204abcfb67a9a55a86bfc3ba81c46b5d6f5fd9cc9e40bf67fd7cea81b054108ef7c7b29bab21a29b38042b01c
+  metadata.gz: bf3283be3e11cdacc296af03433775a172ac14cc28fbec679359677e1fb0416ab9ef587400823d8e72ba07731af15abb98bbc5a1954511878352df59734ee3d5
+  data.tar.gz: f7a4fac0ac9322ad16f579f2f4c8957d89b218187132797273340922b0c67a7ac5450906945a93503f60a4123b227e39c7c48dda53a9fc87c84058ea2a8bb31e

data/README.md

@@ -39,7 +39,7 @@ The client follows the [12-factor](http://12factor.net/config) apps principle an
 # Initialize using parameters
 interfax = InterFAX::Client.new(username: '...', password: '...')
 
-# Alternatice: Initialize using environment variables
+# Alternative: Initialize using environment variables
 # * INTERFAX_USERNAME
 # * INTERFAX_PASSWORD
 interfax = InterFAX::Client.new
@@ -248,14 +248,14 @@ interfax.inbound.find(123456)
 
 `interfax.inbound.image(fax_id)`
 
-Retrieves a single fax's image.
+Retrieves a single fax's image. This can be a PDF or a TIFF file.
 
 ```ruby
 image = interfax.inbound.image(123456)
 => #<InterFAX::Image>
 image.data
 => # "....binary data...."
-image.save('fax.tiff')
+image.save("path/to/fax.#{image.extension}")
 => # saves image to file
 ```
 
@@ -513,8 +513,18 @@ document.id  # Extracts the ID from the URI (the API does not return the ID)
  1. **Fork** the repo on GitHub
  2. **Clone** the project to your own machine
  3. **Commit** changes to your own branch
- 4. **Push** your work back up to your fork
- 5. Submit a **Pull request** so that we can review your changes
+ 4. **Test** the changes you have made
+ 5. **Push** your work back up to your fork
+ 6. Submit a **Pull request** so that we can review your changes
+
+### Testing
+
+Before submitting a contribution please ensure all tests pass.
+
+```sh
+bundle install # install dependencies
+rake spec # run all tests
+```
 
 ## License
 

data/lib/interfax/client.rb

@@ -104,6 +104,8 @@ module InterFAX
       when Net::HTTPSuccess
         if response['location']
           response['location']
+        elsif tiff?(response) || pdf?(response)
+          return [response.body, response['Content-Type']]
         elsif json?(response)
           begin
             JSON.parse(response.body)
@@ -128,11 +130,23 @@ module InterFAX
       end
     end
 
+    def pdf?(response)
+      type?(response, 'application/pdf')
+    end
+
+    def tiff?(response)
+      type?(response, 'image/tiff')
+    end
+
     def json?(response)
+      type?(response, 'text/json')
+    end
+
+    def type?(response, mime_type)
       content_type = response['Content-Type']
-      json_header = content_type && content_type.split(';').first == 'text/json'
+      correct_header = content_type && content_type.split(';').first == mime_type
       has_body = response.body && response.body.length > 0
-      json_header && has_body
+      correct_header && has_body
     end
   end
 end

data/lib/interfax/image.rb

@@ -7,6 +7,14 @@ class InterFAX::Image < InterFAX::Object
     result
   end
 
+  def extension
+    if mimeType == 'application/pdf'
+      'pdf'
+    else
+      'tiff'
+    end
+  end
+
   def save filename
     File.open(filename, 'wb') do |file|
       file.write(data)

data/lib/interfax/inbound.rb

@@ -18,8 +18,8 @@ class InterFAX::Inbound
   end
 
   def image fax_id
-    data = @client.get("/inbound/faxes/#{fax_id}/image")
-    InterFAX::Image.new(data: data, client: @client)
+    data, mimeType = @client.get("/inbound/faxes/#{fax_id}/image")
+    InterFAX::Image.new(data: data, client: @client, mimeType: mimeType)
   end
 
   def mark fax_id, options = {}

data/lib/interfax/outbound.rb

@@ -38,8 +38,8 @@ class InterFAX::Outbound
   end
 
   def image fax_id
-    data = @client.get("/outbound/faxes/#{fax_id}/image")
-    InterFAX::Image.new(data: data, client: @client)
+    data, mimeType = @client.get("/outbound/faxes/#{fax_id}/image")
+    InterFAX::Image.new(data: data, client: @client, mimeType: mimeType)
   end
 
   def cancel fax_id

data/lib/interfax/version.rb

@@ -1,3 +1,3 @@
 module InterFAX
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interfax
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - InterFAX
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic