maremma 1.1.1 → 2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: d1d7346d45d16d11fc07441c7c5bdf76c9acb53e
-  data.tar.gz: 6923eda4b67c04267bd9a0b03af2d6e9dbb7471d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTA2M2VjNzdhZmE4YmNkNzdlZDEwNWNjYWQ4NjllZGEyNDY2NDc2Yw==
+  data.tar.gz: !binary |-
+    ZTg5NWYyY2JkZmUzYTBmNWVlYjU3NGI1NTE2NmQzZTcxODE5MzRkNw==
 SHA512:
-  metadata.gz: a4f9ec4cec2540d3eedb1d227c2bbb495fa079ad865c532f92c7f9622d2804efaefe07af152365763f30de13c15e186603271f75f0551debd8d70588a4295de8
-  data.tar.gz: 6038be3dba218bbc1031a1d25226331514cb631a3ed65c7c6642930fd0b335f283159a36ff20cab7f802cc34c2d27e436fa5938552e10db5b662eaebb9a17cf0
+  metadata.gz: !binary |-
+    YjRkODhhNWJkMDc1OWEyYmI4OGUxYjAxY2RhZmNhMjM3YTEzNzdiYjY3OWQ4
+    ZDFlYTYwY2UzOGI3MWRiMWQwYzM0MWNmZDhhMWZmYzI4NTAzMzBiMmI3YjQ4
+    Y2U4ZDIzNjFmZjU1NjFlNWRjYjc2M2QxZjM5NmNjNTdhMmQzMjk=
+  data.tar.gz: !binary |-
+    OTUwYjE3YmVlZmE2MzIzYTEyNTJmMGRhNzI3MjRhNDU5NDk3YjUxNDJiMjRj
+    MDdkZTYzNjNkNmExNzQ4N2JmZDM3ODhmMTllOWRjNDBlMTRkZjc3ZGE3NWIw
+    NjU2ZDZhOGQ5ZjY2MTk2MGM4NDk0ZmE0YTkwNjQxMzQyZWY5Mjk=

data/.travis.yml

@@ -12,3 +12,6 @@ deploy:
   on:
     tags: true
     repo: datacite/maremma
+
+notifications:
+  slack: datacite:Wt8En0ALoTA6Kjc5EOKNDWxN

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v.2.0 (January 24, 2016)
+
+[maremma 2.0](https://github.com/datacite/maremma/releases/tag/v.2.0) was released on January 24, 2015:
+
+* return JSONAPI-friendly `errors` hash on errors, and `data` hash otherwise
+
 ## v.1.1.0 (January 5, 2016)
 
 [maremma 1.1](https://github.com/datacite/maremma/releases/tag/v.1.1.0) was released on January 5, 2015:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maremma (1.1.0)
+    maremma (2.0)
       activesupport (~> 4.2, >= 4.2.5)
       builder (~> 3.2, >= 3.2.2)
       excon (~> 0.45.0)
@@ -81,6 +81,3 @@ DEPENDENCIES
   rspec (~> 3.4)
   vcr
   webmock (~> 1.22, >= 1.22.3)
-
-BUNDLED WITH
-   1.11.2

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/datacite/maremma.svg?branch=master)](https://travis-ci.org/datacite/maremma)
 [![Code Climate](https://codeclimate.com/github/datacite/maremma/badges/gpa.svg)](https://codeclimate.com/github/datacite/maremma)
 
-Utility library for network calls. Based on [Faraday](https://github.com/lostisland/faraday) and [Excon](https://github.com/excon/excon), provides a wrapper for XML/JSON parsing and error handling.
+Utility library for network calls. Based on [Faraday](https://github.com/lostisland/faraday) and [Excon](https://github.com/excon/excon), provides a wrapper for XML/JSON parsing and error handling. All successful responses are returned as hash with key `data`, all errors in a JSONAPI-friendly hash with key `errors`.
 
 ## Installation
 

data/lib/maremma.rb

@@ -33,7 +33,7 @@ module Maremma
     response = conn.post url, {}, options[:headers] do |request|
       request.body = options[:data]
     end
-    parse_response(response.body)
+    parse_success_response(response.body)
   rescue *NETWORKABLE_EXCEPTIONS => error
     rescue_faraday_error(error)
   end
@@ -52,10 +52,10 @@ module Maremma
 
     # return error if we are close to the rate limit, if supported in headers
     if get_rate_limit_remaining(response.headers) < 10
-      return { error: "Rate limit soon exceeded", status: 429 }
+      return { 'errors' => [{ 'status' => 429, 'title' => "Too many requests" }] }
     end
 
-    parse_response(response.body)
+    parse_success_response(response.body)
   rescue *NETWORKABLE_EXCEPTIONS => error
     rescue_faraday_error(error)
   end
@@ -95,11 +95,25 @@ module Maremma
 
   def self.rescue_faraday_error(error)
     if error.is_a?(Faraday::ResourceNotFound)
-      { error: "resource not found", status: 404 }
+      { 'errors' => [{ 'status' => 404, 'title' => "Not found" }] }
     elsif error.is_a?(Faraday::TimeoutError) || error.is_a?(Faraday::ConnectionFailed) || (error.try(:response) && error.response[:status] == 408)
-      { error: "execution expired", status: 408 }
+      { 'errors' => [{ 'status' => 408, 'title' =>"Request timeout" }] }
     else
-      { error: parse_error_response(error.message), status: 400 }
+      { 'errors' => [{ 'status' => 400, 'title' => parse_error_response(error.message) }] }
+    end
+  end
+
+  def self.parse_success_response(string)
+    string = parse_response(string)
+
+    if string == ""
+      { 'data' => nil }
+    elsif string.is_a?(Hash) && string['data']
+      string
+    elsif string.is_a?(Hash) && string['hash']
+      { 'data' => string['hash'] }
+    else
+      { 'data' => string }
     end
   end
 
@@ -113,12 +127,12 @@ module Maremma
     end
   end
 
+  protected
+
   def self.parse_response(string)
     from_json(string) || from_xml(string) || from_string(string)
   end
 
-  protected
-
   # currently supported by Twitter and Github
   # with slightly different header names
   # use arbitrary high value if not supported

data/lib/maremma/version.rb

@@ -1,3 +1,3 @@
 module Maremma
-  VERSION = "1.1.1"
+  VERSION = "2.0"
 end

data/spec/maremma_spec.rb

@@ -10,21 +10,21 @@ describe Maremma do
     it "get json" do
       stub = stub_request(:get, url).to_return(:body => data.to_json, :status => 200, :headers => { "Content-Type" => "application/json" })
       response = subject.get(url)
-      expect(response).to eq(data)
+      expect(response).to eq("data" => data)
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_return(:body => data.to_xml, :status => 200, :headers => { "Content-Type" => "application/xml" })
       response = subject.get(url, content_type: 'xml')
-      expect(response).to eq('hash' => data)
+      expect(response).to eq("data" => data)
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_return(:body => data.to_s, :status => 200, :headers => { "Content-Type" => "text/html" })
       response = subject.get(url, content_type: 'html')
-      expect(response).to eq(data.to_s)
+      expect(response).to eq("data" => data.to_s)
       expect(stub).to have_been_requested
     end
 
@@ -39,33 +39,33 @@ describe Maremma do
     it "get json" do
       stub = stub_request(:get, url).to_return(:body => nil, :status => 200, :headers => { "Content-Type" => "application/json" })
       response = subject.get(url)
-      expect(response).to be_blank
+      expect(response).to eq("data" => nil)
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_return(:body => nil, :status => 200, :headers => { "Content-Type" => "application/xml" })
       response = subject.get(url, content_type: 'xml')
-      expect(response).to be_blank
+      expect(response).to eq("data" => nil)
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_return(:body => nil, :status => 200, :headers => { "Content-Type" => "text/html" })
       response = subject.get(url, content_type: 'html')
-      expect(response).to be_blank
+      expect(response).to eq("data" => nil)
       expect(stub).to have_been_requested
     end
 
     it "post xml" do
       stub = stub_request(:post, url).with(:body => post_data.to_xml).to_return(:body => nil, :status => 200, :headers => { "Content-Type" => "application/xml" })
-      subject.post(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
+      subject.post(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to eq("data" => nil) }
       expect(stub).to have_been_requested
     end
   end
 
   context "not found" do
-    let(:error) { { error: "resource not found", status: 404 } }
+    let(:error) { { "errors" => [{ "status" => 404, "title" => "Not found" }]} }
 
     it "get json" do
       stub = stub_request(:get, url).to_return(:body => error.to_json, :status => [404], :headers => { "Content-Type" => "application/json" })
@@ -96,21 +96,21 @@ describe Maremma do
     it "get json" do
       stub = stub_request(:get, url).to_return(:status => [408])
       response = subject.get(url)
-      expect(response).to eq(error: "execution expired", status: 408)
+      expect(response).to eq("errors"=>[{"status"=>408, "title"=>"Request timeout"}])
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_return(:status => [408])
       response = subject.get(url, content_type: 'xml')
-      expect(response).to eq(error: "execution expired", status: 408)
+      expect(response).to eq("errors"=>[{"status"=>408, "title"=>"Request timeout"}])
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_return(:status => [408])
       response = subject.get(url, content_type: 'html')
-      expect(response).to eq(error: "execution expired", status: 408)
+      expect(response).to eq("errors"=>[{"status"=>408, "title"=>"Request timeout"}])
       expect(stub).to have_been_requested
     end
 
@@ -125,21 +125,21 @@ describe Maremma do
     it "get json" do
       stub = stub_request(:get, url).to_timeout
       response = subject.get(url)
-      expect(response).to eq(error: "execution expired", status: 408)
+      expect(response).to eq("errors"=>[{"status"=>408, "title"=>"Request timeout"}])
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_timeout
       response = subject.get(url, content_type: 'xml')
-      expect(response).to eq(error: "execution expired", status: 408)
+      expect(response).to eq("errors"=>[{"status"=>408, "title"=>"Request timeout"}])
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_timeout
       response = subject.get(url, content_type: 'html')
-      expect(response).to eq(error: "execution expired", status: 408)
+      expect(response).to eq("errors"=>[{"status"=>408, "title"=>"Request timeout"}])
       expect(stub).to have_been_requested
     end
 
@@ -154,21 +154,21 @@ describe Maremma do
     it "get json" do
       stub = stub_request(:get, url).to_return(status: 200, headers: { 'X-Rate-Limit-Remaining' => 3 })
       response = subject.get(url)
-      expect(response).to eq(error: "Rate limit soon exceeded", status: 429)
+      expect(response).to eq("errors"=>[{"status"=>429, "title"=>"Too many requests"}])
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_return(status: 200, headers: { 'X-Rate-Limit-Remaining' => 3 })
       response = subject.get(url, content_type: 'xml')
-      expect(response).to eq(error: "Rate limit soon exceeded", status: 429)
+      expect(response).to eq("errors"=>[{"status"=>429, "title"=>"Too many requests"}])
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_return(status: 200, headers: { 'X-Rate-Limit-Remaining' => 3 })
       response = subject.get(url, content_type: 'html')
-      expect(response).to eq(error: "Rate limit soon exceeded", status: 429)
+      expect(response).to eq("errors"=>[{"status"=>429, "title"=>"Too many requests"}])
       expect(stub).to have_been_requested
     end
 
@@ -187,7 +187,7 @@ describe Maremma do
       stub_request(:get, url).to_return(status: 301, headers: { location: redirect_url })
       stub_request(:get, redirect_url).to_return(status: 200, body: "Test")
       response = subject.get(url)
-      expect(response).to eq("Test")
+      expect(response).to eq("data"=>"Test")
     end
 
     it "redirect four times" do
@@ -197,7 +197,7 @@ describe Maremma do
       stub_request(:get, redirect_url+ "/y").to_return(status: 301, headers: { location: redirect_url + "/z" })
       stub_request(:get, redirect_url + "/z").to_return(status: 200, body: "Test")
       response = subject.get(url)
-      expect(response).to eq("Test")
+      expect(response).to eq("data"=>"Test")
     end
   end
 
@@ -218,25 +218,25 @@ describe Maremma do
     end
   end
 
-  context 'parse_response' do
+  context 'parse_success_response' do
     it 'from_json' do
       string = '{ "word": "abc" }'
-      expect(subject.parse_response(string)).to eq("word" => "abc")
+      expect(subject.parse_success_response(string)).to eq("data"=>{"word"=>"abc"})
     end
 
     it 'from_xml' do
       string = "<word>abc</word>"
-      expect(subject.parse_response(string)).to eq("word" => "abc")
+      expect(subject.parse_success_response(string)).to eq("data"=>{"word"=>"abc"})
     end
 
     it 'from_string' do
       string = "abc"
-      expect(subject.parse_response(string)).to eq("abc")
+      expect(subject.parse_success_response(string)).to eq("data"=>"abc")
     end
 
     it 'from_string with utf-8' do
       string = "fön  "
-      expect(subject.parse_response(string)).to eq("fön")
+      expect(subject.parse_success_response(string)).to eq("data"=>"fön")
     end
   end
 end

metadata

@@ -1,241 +1,241 @@
 --- !ruby/object:Gem::Specification
 name: maremma
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '2.0'
 platform: ruby
 authors:
 - Martin Fenner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !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: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: faraday-encoding
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.45.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.45.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.6.4
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.2.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
 - !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: rack-test
   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: vcr
   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: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.22'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.22.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.22'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.22.3
 description: Simplifies network calls, including json/xml parsing and error handling.
@@ -246,8 +246,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -269,20 +269,18 @@ 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.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simplified network calls
-test_files:
-- spec/maremma_spec.rb
-- spec/spec_helper.rb
+test_files: []