ink_file_picker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b9c7875362ff6bf4c1184114dcd2c1481ac4620
-  data.tar.gz: 4c58dbe3e7a6677f38bc9149f8240c1352de344b
+  metadata.gz: b7a681af38820d24f5944958571caa2ec6e9a2a2
+  data.tar.gz: c689b7e0f95090e1563c3aa10de8bcd85e3e240b
 SHA512:
-  metadata.gz: a5e696624475b6c20b69eea7fc335dd6787951c5be8c63160dd641a570fed579bc625ec8154a449ae608204f2a834ea3c457ffaecd5bd96e273486e366c76e5a
-  data.tar.gz: fba1614dea4bf46e59cab2574e0713cc4947d79471c9a364f2fd72d911bf7784684236fbe81490e69c87365587b31bddeecba0a9698f52accb2b808bc91680c8
+  metadata.gz: 006cda13b071eaf270d6c99dde3423e21cc3506f297cdbbc44f66dfdd1478664633f10e6a634b6e15aeee76abea4571cc117bd9365d994864307c6e9ac581a84
+  data.tar.gz: ac22138a939849a2521d635178fdeeeef8b462290db9427bb039bcb1d63ddf8928875b05b9df1b88c96c4bef520b081e3858055a99013434a12fe71dfdf2519f

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.2
+  - ruby-head
+  - jruby-19mode
+  - jruby
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.0.3
+* Raise UnexpectedResponseError if we receive a 200 OK, but response body is neither "success", nor valid JSON.
+  This may happen if you ask File Picker to download a URL, but the server for the given URL fails to respond
+  within five(?) seconds. We will then have a 200 OK, but the body will reveal the timeout error in text and
+  the UnexpectedResponseError is raised. Other download errors may also be in the response, for instance
+  "Invalid response when trying to read from `http://some.url.com/here.jpg`.
+
+
+## 0.0.2
+* You can call to_hash on response objects.
+
+## 0.0.1
+* First release. Main functionality like store_url, store_file, remove, stat etc.

data/README.md

@@ -2,6 +2,7 @@
 
 Ruby API client for Ink File Picker (known as filepicker.io).
 
+[![Build Status](https://travis-ci.org/Skalar/ink_file_picker.svg?branch=master)](https://travis-ci.org/Skalar/ink_file_picker)
 
 
 ## Installation
@@ -51,8 +52,9 @@ url = client.convert_url url_or_handle_name, w: 100, h: 100
 url = client.convert_url url_or_handle_name, {w: 100, h: 100}, expiry: 10.minutes.from_now.to_i
 
 # Adds policy and signature, if secret given when client was created.
+get_params = {} # Get params we'll be adding to the request.
 url = client.retrieve_url url_or_handle_name
-url = client.retrieve_url url_or_handle_name, expiry: 10.minutes.from_now.to_i
+url = client.retrieve_url url_or_handle_name, get_params, expiry: 10.minutes.from_now.to_i
 
 
 # Get simple stat on a file, like the Javascript client
@@ -66,6 +68,10 @@ dimentions = client.stat url_or_handle_name, {width: true, height: true}
 When making requests to the API errors may occur. `InkFilePicker::ClientError` or `InkFilePicker::ServerError` will
 be raised if we are getting 4xx or 5xx responses back from File Picker. All errors inherits from `InkFilePicker::Error`.
 
+We may also fail with a `InkFilePicker::UnexpectedResponseError`. This happens when for instance you ask File Picker
+to download a URL, but the server for the given URL fails to respond within five(?) seconds. We will then get a 200 OK,
+but the body will reveal the timeout error in text and the UnexpectedResponseError is raised.
+Other download errors may also be in the response, for instance "Invalid response when trying to read from `http://some.url.com/here.jpg`.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/lib/ink_file_picker/client.rb

@@ -170,7 +170,9 @@ module InkFilePicker
     def wrap_response_or_fail_unless_success!(response)
       case response.status
       when 200...300
-        Response.new response
+        Response.new(response).tap do |wrapped_response|
+          fail UnexpectedResponseError, response.body unless wrapped_response.valid?
+        end
       when 400...500
         fail ClientError.new response.body, response
       when 500...600

data/lib/ink_file_picker/errors.rb

@@ -33,4 +33,22 @@ module InkFilePicker
   class ClientError < Error
     include ErrorWithOriginal
   end
+
+  # Public: When FilePicker returns 200 OK http status, but body is unexpected.
+  #
+  # These errors mainly comes from http status code 200, but at the same time the
+  # body is not 'success' neither a parsable JSON string.
+  #
+  # This seem to happen, for instance when you ask File Picker to store a URL
+  # and the remote server we want to download files from takes more than 5 seconds
+  # before it starts sending data. At this point FilePicker returns 200 OK, with a
+  # body like:
+  # "[uuid=D93D897C42254BFA] Invalid URL file http://www.example.com/slow-response.jpg - timeout"
+  #
+  # In stead of returning this response and get a JSON::ParserError down the road
+  # we fail as soon as we see something like this.
+  #
+  # As of writing this I don't know if this is the best solution to the situation.
+  class UnexpectedResponseError < Error
+  end
 end

data/lib/ink_file_picker/response.rb

@@ -29,5 +29,12 @@ module InkFilePicker
     def parsed_body
       @parsed_body ||= JSON.parse http_response.body
     end
+
+    def valid?
+      body == 'success' ||
+      parsed_body
+    rescue JSON::ParserError
+      false
+    end
   end
 end

data/lib/ink_file_picker/version.rb

@@ -1,3 +1,3 @@
 module InkFilePicker
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/ink_file_picker/client_spec.rb

@@ -72,6 +72,23 @@ describe InkFilePicker::Client do
         expect { subject.store_url url, expiry: 1394363896 }.to raise_error InkFilePicker::ClientError
       end
 
+      it "handles timeout error on remote server correctly" do
+        response_body = "[uuid=D93D897C42254BFB] Invalid URL file http://vp.viseno.no/vp_image.php?type=create_project_letter_head&id=1378387&ts=20140413133631&source_mediatype_code=shoebox_hq&format=jpeg&resolution=300&relative=true&scale=bestfit - timeout"
+
+        stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+          store_path = subject.configuration.store_path + '?key=key&policy=eyJleHBpcnkiOjEzOTQzNjM4OTYsImNhbGwiOiJzdG9yZSJ9&signature=60cb43bb945543d7fdbd2662ae21d5c53e28529720263619cfebc3509e820807'
+          stub.post(store_path, {url: url}) { [200, {}, response_body] }
+        end
+
+        stubbed_connection = Faraday.new do |builder|
+          builder.adapter :test, stubs
+        end
+
+        subject.stub(:http_connection).and_return stubbed_connection
+
+        expect { subject.store_url url, expiry: 1394363896 }.to raise_error InkFilePicker::UnexpectedResponseError
+      end
+
       it "handles server errors correctly" do
         stubs = Faraday::Adapter::Test::Stubs.new do |stub|
           store_path = subject.configuration.store_path + '?key=key&policy=eyJleHBpcnkiOjEzOTQzNjM4OTYsImNhbGwiOiJzdG9yZSJ9&signature=60cb43bb945543d7fdbd2662ae21d5c53e28529720263619cfebc3509e820807'

data/spec/ink_file_picker/response_spec.rb

@@ -37,4 +37,20 @@ describe InkFilePicker::Response do
       expect(subject.public_send name).to eq 'an answer'
     end
   end
+
+  describe "#valid?" do
+    context "valid JSON as body" do
+      it "is true" do
+        expect(subject).to be_valid
+      end
+    end
+
+    context "invalid JSON as body" do
+      let(:http_response_body) { '[uuid=D93D897C42254BFB] Invalid URL file http://vp.viseno.no/vp_image.php?type=create_project_letter_head&id=1378387&ts=20140413133631&source_mediatype_code=shoebox_hq&format=jpeg&resolution=300&relative=true&scale=bestfit - timeout' }
+
+      it "is false" do
+        expect(subject).to_not be_valid
+      end
+    end
+  end
 end

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: ink_file_picker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Thorbjørn Hermansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.14
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.14
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 description: 
@@ -93,7 +93,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -127,17 +129,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Client for Ink File Picker