mojfile-uploader-api-client 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aae9dbfec4bdac54e4ba2f30d9b1b1976c479d75
-  data.tar.gz: 2a1bdac42dfaa9c62ffb7ffc1f088ffe73211f5b
+  metadata.gz: 3066638f8cdc9294e76ca66e896be9e92310ee07
+  data.tar.gz: 65258501e71ef231634d86c79c56d5851de4ac20
 SHA512:
-  metadata.gz: 8885d3f80dbcc410c732745f4020a9f4ad770f86d6a5b31fe22775301456571615d1bb57ba8f82a03411987ecd49db8d64f986d79f3bfd53b4f008c690e4db01
-  data.tar.gz: e93853d922b4f659f6a6f206569bce11470fbcc76b4cfd5ca5281627fb4ef9a7ac87ab9fea2fada8bd97dc1c1a5763d2d5fb1a94d8635a41ddf6c2c099dfcef0
+  metadata.gz: 786bf3d8b142bab2de0ae53f30cdf10e314510b0ee3b2e71727206225ba9ac43984367615ad7ec0ca97aeab14b3bf6315e49c336c33e51b99ea9e45ced98259c
+  data.tar.gz: c3eab59fb289635295b6e8f458ad4ba3b0b16e933413d6812b87c39ee5d7e765705dc86572d9e3e563c3b6df1ca960f6d9135cf9161166a228cd7712435bf351

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mojfile-uploader-api-client (0.1.1)
+    mojfile-uploader-api-client (0.2)
       rest-client (~> 2.0.0)
 
 GEM
@@ -140,4 +140,4 @@ DEPENDENCIES
   rubocop (~> 0.41)
 
 BUNDLED WITH
-   1.13.6
+   1.14.4

data/README.md

@@ -20,6 +20,13 @@ end
 
 #### When a previous collection reference is known:
 
+```ruby
+MojFileUploaderApiClient.add_file(title: 'test', filename: 'test.txt', data: 'bla bla bla', collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757')
+=> {:collection=>"a45c556f-a628-41d3-8c29-351f84e63757", :key=>"7c6aca2c-eb7a-4194-8166-9fd6ac82127b.test.txt"}
+```
+
+Or you can use the `AddFile` client directly:
+
 ```ruby
 MojFileUploaderApiClient::AddFile.new(title: 'test', filename: 'test.txt', data: 'bla bla bla', collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757').call
 
@@ -30,6 +37,13 @@ MojFileUploaderApiClient::AddFile.new(title: 'test', filename: 'test.txt', data:
 
 #### No previous collection reference (will create a new one):
 
+```ruby
+MojFileUploaderApiClient.add_file(title: 'test', filename: 'test.txt', data: 'bla bla bla')
+=> {:collection=>"741635f7-488a-49cc-a3f1-9ee38795e28e", :key=>"0543a21d-e884-4076-89be-41cc09b00da1.test.txt"}
+```
+
+Or you can use the `AddFile` client directly:
+
 ```ruby
 MojFileUploaderApiClient::AddFile.new(title: 'test', filename: 'test.txt', data: 'bla bla bla').call
 
@@ -40,6 +54,13 @@ MojFileUploaderApiClient::AddFile.new(title: 'test', filename: 'test.txt', data:
 
 ### Delete a file
 
+```ruby
+MojFileUploaderApiClient.delete_file(collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757', filename: 'test1.txt')
+=> RequestError
+```
+
+Or you can use the `DeleteFile` client directly:
+
 ```ruby
 MojFileUploaderApiClient::DeleteFile.new(collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757', filename: 'test1.txt').call
 => #<MojFileUploaderApiClient::Response:0x007fe4e59c8098 @body={:body_parser_error=>"743: unexpected token at ''"}, @code=204>
@@ -47,12 +68,20 @@ MojFileUploaderApiClient::DeleteFile.new(collection_ref: 'a45c556f-a628-41d3-8c2
 
 ### List files
 
+```ruby
+MojFileUploaderApiClient.list_files(collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757')
+=> {:collection=>"a45c556f-a628-41d3-8c29-351f84e63757",
+    :files=>[{:key=>"a45c556f-a628-41d3-8c29-351f84e63757/test1.txt", :title=>"test1.txt", :last_modified=>"2016-11-30T15:30:52.000Z"}]}
+```
+
+Or you can use the `ListFiles` client directly:
+
 ```ruby
 MojFileUploaderApiClient::ListFiles.new(collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757').call
 => #<MojFileUploaderApiClient::Response:0x007fe4e5ac91e0
  @body=
   {:collection=>"a45c556f-a628-41d3-8c29-351f84e63757",
-   :files=>[{:key=>"a45c556f-a628-41d3-8c29-351f84e63757/test1.txt", :title=>"test1.txt", :last_modified=>"2016-11-30T15:30:52.000Z"}]},
+   :files=>[{:key=>"a45c556f-a628-41d3-8c29-351f84e63757/test1.txt", :title=>"test1.txt", :last_modified=>"2016-11-30T15:30:52.000Z"}]}
  @code=200>
 ```
 

data/lib/mojfile_uploader_api_client.rb

@@ -10,6 +10,35 @@ require 'mojfile_uploader_api_client/delete_file'
 require 'mojfile_uploader_api_client/list_files'
 
 module MojFileUploaderApiClient
+  INFECTED_FILE_RESPONSE_CODE = 400
+
   class Unavailable < StandardError; end
   class RequestError < StandardError; end
+  class InfectedFileError < StandardError; end
+
+  def self.add_file(params)
+    response = AddFile.new(params).call
+
+    if response.success?
+      response.body
+    elsif response.code.equal?(INFECTED_FILE_RESPONSE_CODE)
+      raise InfectedFileError
+    else
+      raise RequestError
+    end
+  end
+
+  def self.delete_file(params)
+    response = DeleteFile.new(params).call
+
+    raise RequestError unless response.success?
+    response.body
+  end
+
+  def self.list_files(params)
+    response = ListFiles.new(params).call
+
+    raise RequestError unless response.success?
+    response.body
+  end
 end

data/lib/mojfile_uploader_api_client/response.rb

@@ -1,10 +1,12 @@
 module MojFileUploaderApiClient
   class Response
-    attr_accessor :code, :body
+    class UnparsableResponseError < RuntimeError; end
+
+    attr_accessor :code
 
     def initialize(code:, body:)
-      self.code = code
-      self.body = parse_body(body)
+      @code = code
+      @raw_body = body
     end
 
     def success?
@@ -15,13 +17,17 @@ module MojFileUploaderApiClient
       !success?
     end
 
+    def body
+      @body ||= parse_body
+    end
+
     private
 
-    def parse_body(body)
-      return body if ['', nil].include?(body)
-      JSON.parse(body, symbolize_names: true)
-    rescue JSON::ParserError => ex
-      {body_parser_error: ex.message}
+    def parse_body
+      return if @raw_body.nil? || @raw_body.empty?
+      JSON.parse(@raw_body, symbolize_names: true)
+    rescue JSON::ParserError
+      raise UnparsableResponseError
     end
   end
 end

data/lib/mojfile_uploader_api_client/version.rb

@@ -1,3 +1,3 @@
 module MojFileUploaderApiClient
-  VERSION = '0.1.1'
+  VERSION = '0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mojfile-uploader-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Jesus Laiz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: API client for integration with the MOJ File Uploader