maremma 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba82a8adc41f610974a1e5f0fee1616d04e4d465
-  data.tar.gz: 4eaf91d77ceebe086c1bdeab2f068d9e143a5c68
+  metadata.gz: 324339036e6fd309bcbc293699a5a95c7d409144
+  data.tar.gz: c9a3f3e36193f7290be939b904239dda6aefafc4
 SHA512:
-  metadata.gz: ba82e06bd569ae40504b93c0d4327c0f53d76d06bb198d4100209e3501101de59dfa957b66ec61009b5350b1817eaa43f7c4ceb32824bade269e5bed8738736f
-  data.tar.gz: 234196702252c07ae88ba1bcd57d41b130751c8230a06056429d18171ccbe239903c8ea4db22c9dd88cb7a75ea79f1f0667bf564979426493b32e291359f2c3e
+  metadata.gz: 2f6152f610737e07bbd72aad5ef3b7f3ccd329dca72beeb26402ea6dc58cdfeb3bf25d6e39fa9181c9b82d72390f35d907083df6f983fc79a698fefba1a7a3ee
+  data.tar.gz: c16cc48c7b0c97317eb358ef7ae047b83cc3a7d57732b2d5171d8a481053f5f00e70c56ec3f5aaf430a4d9e2c94579841f08ef1d1a9cf38df67f9bb9ad9e4f47

data/.travis.yml

@@ -1,9 +1,18 @@
 language: ruby
 rvm:
-- 2.3.1
+- 2.3.3
+
+addons:
+  code_climate:
+    repo_token: $CODECLIMATE_REPO_TOKEN
+    
 install:
 - travis_retry bundle install
-script: bundle exec rspec
+
+script:
+- bundle exec rspec
+- bundle exec codeclimate-test-reporter
+
 deploy:
   provider: rubygems
   api_key:
@@ -14,4 +23,5 @@ deploy:
     repo: datacite/maremma
 
 notifications:
+  email: false
   slack: datacite:Wt8En0ALoTA6Kjc5EOKNDWxN

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maremma (3.5.1)
+    maremma (3.5.2)
       activesupport (~> 4.2, >= 4.2.5)
       addressable (>= 2.3.6)
       builder (~> 3.2, >= 3.2.2)
@@ -16,9 +16,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.7.1)
+    activesupport (4.2.8)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
@@ -39,7 +38,7 @@ GEM
     faraday_middleware (0.10.1)
       faraday (>= 0.7.4, < 1.0)
     hashdiff (0.3.2)
-    i18n (0.8.0)
+    i18n (0.8.1)
     json (1.8.6)
     mini_portile2 (2.1.0)
     minitest (5.10.1)

data/README.md

@@ -1,11 +1,12 @@
-# Maremma
-
+[![Identifier](https://img.shields.io/badge/doi-10.5438%2Fqeg0--3gm3-fca709.svg)](https://doi.org/10.5438/qeg0-3gm3)
 [![Gem Version](https://badge.fury.io/rb/maremma.svg)](https://badge.fury.io/rb/maremma)
 [![Build Status](https://travis-ci.org/datacite/maremma.svg?branch=master)](https://travis-ci.org/datacite/maremma)
-[![Test Coverage](https://codeclimate.com/github/datacite/maremma/badges/coverage.svg)](https://codeclimate.com/github/datacite/maremma/coverage)
 [![Code Climate](https://codeclimate.com/github/datacite/maremma/badges/gpa.svg)](https://codeclimate.com/github/datacite/maremma)
+[![Test Coverage](https://codeclimate.com/github/datacite/maremma/badges/coverage.svg)](https://codeclimate.com/github/datacite/maremma/coverage)
+
+# Maremma: a Ruby library for simplified network calls
 
-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`.
+Ruby utility library for network requests. 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/codemeta.json

@@ -0,0 +1,36 @@
+{
+	"@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
+	"@type": "SoftwareSourceCode",
+	"@id": "https://doi.org/10.5438/QEG0-3GM3",
+	"agents": {
+		"@id": "http://orcid.org/0000-0003-0077-4738",
+		"@type": "person",
+		"name": "Martin Fenner",
+		"affiliation": "DataCite",
+		"mustBeCited": true,
+		"isMaintainer": true,
+		"isRightsHolder": true
+	},
+	"identifier": "https://doi.org/10.5438/QEG0-3GM3",
+	"codeRepository": "https://github.com/datacite/maremma",
+	"controlledTem": "software",
+	"dateCreated": "2015-11-28",
+	"datePublished": "2017-02-24",
+	"dateModified": "2017-02-24",
+	"description": "Ruby utility library for network requests. Based on Faraday and 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.",
+	"isAutomatedBuild": true,
+	"licenseId": "MIT",
+	"publisher": "DataCite",
+	"tags": [
+		"faraday",
+		"excon",
+		"net/http"
+	],
+	"title": "Maremma: a Ruby library for simplified network calls",
+	"programmingLanguage": {
+		"name": "Ruby",
+		"version": "≥ 2.3.3",
+		"URL": "https://www.ruby-lang.org"
+	},
+	"readme": "https://github.com/datacite/maremma/blob/master/README.md"
+}

data/lib/maremma.rb

@@ -20,85 +20,44 @@ module Maremma
                             ArgumentError,
                             NoMethodError,
                             TypeError]
-                            
-  def self.post(url, options={})
-    is_valid_url?(url)
-
-    options[:data] ||= {}
-    options[:headers] = set_request_headers(url, options)
 
-    conn = faraday_conn(options)
-
-    conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
-
-    response = conn.post url, {}, options[:headers] do |request|
-      request.body = options[:data]
-    end
-    OpenStruct.new(body: parse_success_response(response.body, options),
-                   headers: response.headers,
-                   status: response.status,
-                   url: response.env[:url].to_s)
-  rescue *NETWORKABLE_EXCEPTIONS => error
-    error_response = rescue_faraday_error(error)
-    OpenStruct.new(body: error_response,
-                   status: error_response.fetch("errors", {}).first.fetch("status", 400))
+  def self.post(url, options={})
+    self.method(url, options.merge(method: "post"))
   end
 
   def self.put(url, options={})
-    is_valid_url?(url)
-
-    options[:data] ||= {}
-    options[:headers] = set_request_headers(url, options)
-
-    conn = faraday_conn(options)
-
-    conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
-
-    response = conn.put url, {}, options[:headers] do |request|
-      request.body = options[:data]
-    end
-    OpenStruct.new(body: parse_success_response(response.body, options),
-                   headers: response.headers,
-                   status: response.status,
-                   url: response.env[:url].to_s)
-  rescue *NETWORKABLE_EXCEPTIONS => error
-    error_response = rescue_faraday_error(error)
-    OpenStruct.new(body: error_response,
-                   status: error_response.fetch("errors", {}).first.fetch("status", 400))
+    self.method(url, options.merge(method: "put"))
   end
 
   def self.delete(url, options={})
-    is_valid_url?(url)
-
-    options[:data] ||= {}
-    options[:headers] = set_request_headers(url, options)
-
-    conn = faraday_conn(options)
-
-    conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
+    self.method(url, options.merge(method: "delete"))
+  end
 
-    response = conn.delete url, {}, options[:headers]
+  def self.get(url, options={})
+    self.method(url, options.merge(method: "get"))
+  end
 
-    OpenStruct.new(body: parse_success_response(response.body, options),
-                   headers: response.headers,
-                   status: response.status,
-                   url: response.env[:url].to_s)
-  rescue *NETWORKABLE_EXCEPTIONS => error
-    error_response = rescue_faraday_error(error)
-    OpenStruct.new(body: error_response,
-                   status: error_response.fetch("errors", {}).first.fetch("status", 400))
+  def self.head(url, options={})
+    self.method(url, options.merge(method: "head"))
   end
 
-  def self.get(url, options={})
+  def self.method(url, options={})
     is_valid_url?(url)
 
+    options[:data] ||= {}
     options[:headers] = set_request_headers(url, options)
 
     conn = faraday_conn(options)
 
     conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
 
-    response = conn.get url, {}, options[:headers]
+    response = case options[:method]
+               when "get" then conn.get url, {}, options[:headers]
+               when "post" then conn.post url, {}, options[:headers] { |request| request.body = options[:data] }
+               when "put" then conn.put url, {}, options[:headers] { |request| request.body = options[:data] }
+               when "delete" then conn.delete url, {}, options[:headers]
+               when "head" then conn.head url, {}, options[:headers]
+               end
 
     # return error if we are close to the rate limit, if supported in headers
     if get_rate_limit_remaining(response.headers) < 10
@@ -106,6 +65,7 @@ module Maremma
                             headers: response.headers,
                             status: response.status)
     end
+
     OpenStruct.new(body: parse_success_response(response.body, options),
                    headers: response.headers,
                    status: response.status,
@@ -116,30 +76,6 @@ module Maremma
                    status: error_response.fetch("errors", {}).first.fetch("status", 400))
   end
 
-  def self.head(url, options={})
-    options[:headers] = set_request_headers(url, options)
-
-    conn = faraday_conn(options)
-
-    conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
-
-    response = conn.head url, {}, options[:headers]
-
-    # return error if we are close to the rate limit, if supported in headers
-    if get_rate_limit_remaining(response.headers) < 10
-      return OpenStruct.new(body: { "errors" => [{ 'status' => 429, 'title' => "Too many requests" }] },
-                            headers: response.headers,
-                            status: response.status)
-    end
-    OpenStruct.new(headers: response.headers,
-                   status: response.status,
-                   url: response.env[:url].to_s)
-  rescue *NETWORKABLE_EXCEPTIONS => error
-    error_response = rescue_faraday_error(error)
-    OpenStruct.new(body: error_response,
-                   status: error_response.fetch("errors", {}).first.fetch("status", 400))
-  end
-
   def self.faraday_conn(options = {})
     # make sure we have headers
     options[:headers] ||= {}
@@ -167,43 +103,38 @@ module Maremma
   end
 
   def self.set_request_headers(url, options={})
-    options[:headers] ||= {}
+    header_options = { "html" => 'text/html; charset=UTF-8',
+                       "xml" => 'application/xml',
+                       "json" => 'application/json' }
+
+    headers = options[:headers] ||= {}
 
     # set useragent
-    options[:headers]['User-Agent'] = ENV['HOSTNAME'].present? ? "Maremma - http://#{ENV['HOSTNAME']}" : "Maremma - https://github.com/datacite/maremma"
+    headers['User-Agent'] = ENV['HOSTNAME'].present? ? "Maremma - http://#{ENV['HOSTNAME']}" : "Maremma - https://github.com/datacite/maremma"
 
     # set host, needed for some services behind proxy
-    if options[:host]
-      options[:headers]['Host'] = URI.parse(url).host
-    end
+    headers['Host'] = URI.parse(url).host if options[:host]
 
-    if options[:content_type].present?
-      content_type_headers = { "html" => 'text/html; charset=UTF-8',
-                               "xml" => 'application/xml',
-                               "json" => 'application/json' }
-      options[:headers]['Content-type'] = content_type_headers.fetch(options[:content_type], options[:content_type])
-    end
+    # set Content-Type
+    headers['Content-type'] = header_options.fetch(options[:content_type], options[:content_type]) if options[:content_type].present?
 
     if options[:accept].present?
-      accept_headers = { "html" => 'text/html; charset=UTF-8',
-                         "xml" => 'application/xml',
-                         "json" => 'application/json' }
-      options[:headers]['Accept'] = accept_headers.fetch(options[:accept], options[:accept])
+      headers['Accept'] = header_options.fetch(options[:accept], options[:accept])
     else
       # accept all content
-      options[:headers]['Accept'] ||= "text/html,application/json,application/xml;q=0.9, text/plain;q=0.8,image/png,*/*;q=0.5"
+      headers['Accept'] ||= "text/html,application/json,application/xml;q=0.9, text/plain;q=0.8,image/png,*/*;q=0.5"
     end
 
     if options[:bearer].present?
-      options[:headers]['Authorization'] = "Bearer #{options[:bearer]}"
+      headers['Authorization'] = "Bearer #{options[:bearer]}"
     elsif options[:token].present?
-      options[:headers]["Authorization"] = "Token token=#{options[:token]}"
+      headers["Authorization"] = "Token token=#{options[:token]}"
     elsif options[:username].present?
-      basic = Base64.encode64("#{options[:username]}:#{options[:password].to_s}").rstrip
-      options[:headers]["Authorization"] = "Basic #{basic}"
+      basic = Base64.encode64("#{options[:username]}:#{options[:password]}").rstrip
+      headers["Authorization"] = "Basic #{basic}"
     end
 
-    options[:headers]
+    headers
   end
 
   def self.rescue_faraday_error(error)
@@ -219,6 +150,8 @@ module Maremma
   end
 
   def self.parse_success_response(string, options={})
+    return nil if options[:method] == "head"
+
     string = parse_response(string, options)
 
     if string.blank?

data/lib/maremma/version.rb

@@ -1,3 +1,3 @@
 module Maremma
-  VERSION = "3.5.1"
+  VERSION = "3.5.2"
 end

data/maremma.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.homepage      = "https://github.com/datacite/maremma"
   s.summary       = "Simplified network calls"
   s.date          = Date.today
-  s.description   = "Simplifies network calls, including json/xml parsing and error handling. Based on Faraday."
+  s.description   = "Ruby utility library for network requests. Based on Faraday and 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."
   s.require_paths = ["lib"]
   s.version       = Maremma::VERSION
   s.extra_rdoc_files = ["README.md"]

data/spec/maremma_spec.rb

@@ -70,7 +70,7 @@ describe Maremma do
 
   context "head" do
     it "head html" do
-      stub = stub_request(:head, url).to_return(:body => data.to_s, :status => 200, :headers => { "Content-Type" => "text/html" })
+      stub = stub_request(:head, url).to_return(:status => 200, :headers => { "Content-Type" => "text/html" })
       response = subject.head(url, accept: 'html')
       expect(response.body).to be_nil
       expect(response.headers).to eq("Content-Type"=>"text/html")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maremma
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
 platform: ruby
 authors:
 - Martin Fenner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -286,8 +286,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simplifies network calls, including json/xml parsing and error handling.
-  Based on Faraday.
+description: Ruby utility library for network requests. Based on Faraday and 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.
 email: mfenner@datacite.org
 executables: []
 extensions: []
@@ -302,6 +304,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- codemeta.json
 - lib/maremma.rb
 - lib/maremma/version.rb
 - lib/maremma/xml_converter.rb