maremma 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30550938a1699f8e0e09fdf6292f3e92a23445d0
-  data.tar.gz: 7e61b93e27de91251455a44bfc1fa7cc7c2d8abd
+  metadata.gz: 2afaf83b4f0e5b91eb5b2a74e56a7292919b84d4
+  data.tar.gz: c01ce052e14830d112fdc43e4f6f7cd2da6cfd1f
 SHA512:
-  metadata.gz: 2aac0440dd63a4d48a8fd01ef2345d0e797df2a8ea275eb789b2e6cc96d86fc4466a5023c33f892d3282d8921f3232a63a5243402efbdc5b679c6b79c4c5e30f
-  data.tar.gz: cb1c930340e29f9a2a30f080357aa2bedacb434b895a4dd8710c366ab8b5e36c640963212f7bf9ae51455f0134c4bcf846af40dcb0ee7dfb21b681173650d9fd
+  metadata.gz: 57c2cc958450f2afd128563bfe44226c9a8455cb006d40b3f413349d681347092a4128366f1248618f1211a8306e1fd945adb7cefbda57cc270e86cd89398df1
+  data.tar.gz: ea99d5bfd797b0823f1b6fc4ee8297a69aff7f403056fa83130c0d06da007421350008cb5dd5f1c4ae93684c7b89f4307779568f9c9a3a537fc9c6bc0d61fd37

data/Gemfile.lock

@@ -46,6 +46,7 @@ GEM
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
+    rake (10.4.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -76,6 +77,7 @@ DEPENDENCIES
   bundler (~> 1.0)
   maremma!
   rack-test
+  rake
   rspec (~> 3.4)
   vcr
   webmock

data/README.md

@@ -23,7 +23,7 @@ gem install maremma
 
 ## Usage
 ```ruby
-get_result(url)
+Maremma.get(url)
 ```
 
 ## License

data/lib/maremma.rb

@@ -1 +1,119 @@
-require 'maremma/base'
+require 'active_support/all'
+require 'json'
+require 'nokogiri'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/encoding'
+require 'excon'
+require 'uri'
+
+DEFAULT_TIMEOUT = 60
+NETWORKABLE_EXCEPTIONS = [Faraday::ClientError,
+                          Faraday::TimeoutError,
+                          Faraday::SSLError,
+                          Faraday::ConnectionFailed,
+                          URI::InvalidURIError,
+                          Encoding::UndefinedConversionError,
+                          ArgumentError,
+                          NoMethodError,
+                          TypeError]
+
+module Maremma
+  def self.get(url, content_type: 'json', headers: {}, **options)
+    conn = faraday_conn(content_type, options)
+    conn = auth_conn(conn, options)
+
+    conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
+
+    # make sure we use a 'Host' header
+    headers['Host'] = URI.parse(url).host
+
+    if options[:data]
+      response = conn.post url, {}, headers do |request|
+        request.body = options[:data]
+      end
+    else
+      response = conn.get url, {}, headers
+    end
+    parse_response(response.body)
+  rescue *NETWORKABLE_EXCEPTIONS => error
+    rescue_faraday_error(error)
+  end
+
+  def self.faraday_conn(content_type = 'json', options = {})
+    # use short version for html, xml and json
+    content_types = { "html" => 'text/html; charset=UTF-8',
+                      "xml" => 'application/xml',
+                      "json" => 'application/json' }
+    accept_header = content_types.fetch(content_type, content_type)
+
+    # redirect limit
+    limit = options[:limit] || 10
+
+    Faraday.new do |c|
+      c.headers['Accept'] = accept_header
+      c.headers['User-Agent'] = "spinone - http://#{ENV['HOSTNAME']}"
+      c.use      FaradayMiddleware::FollowRedirects, limit: limit, cookie: :all
+      c.request  :multipart
+      c.request  :json if accept_header == 'application/json'
+      c.use      Faraday::Response::RaiseError
+      c.response :encoding
+      c.adapter  :excon
+    end
+  end
+
+  def self.auth_conn(conn, options)
+    if options[:bearer]
+      conn.authorization :Bearer, options[:bearer]
+    elsif options[:token]
+      conn.authorization :Token, token: options[:token]
+    elsif options[:username]
+      conn.basic_auth(options[:username], options[:password])
+    end
+    conn
+  end
+
+  def self.rescue_faraday_error(error)
+    if error.is_a?(Faraday::ResourceNotFound)
+      { error: "resource not found", status: 404 }
+    elsif error.is_a?(Faraday::TimeoutError) || error.is_a?(Faraday::ConnectionFailed) || (error.try(:response) && error.response[:status] == 408)
+      { error: "execution expired", status: 408 }
+    else
+      { error: parse_error_response(error.message), status: 400 }
+    end
+  end
+
+  def self.parse_error_response(string)
+    string = parse_response(string)
+
+    if string.is_a?(Hash) && string['error']
+      string['error']
+    else
+      string
+    end
+  end
+
+  def self.parse_response(string)
+    from_json(string) || from_xml(string) || from_string(string)
+  end
+
+  protected
+
+  def self.from_xml(string)
+    if Nokogiri::XML(string).errors.empty?
+      Hash.from_xml(string)
+    else
+      nil
+    end
+  end
+
+  def self.from_json(string)
+    JSON.parse(string)
+  rescue JSON::ParserError
+    nil
+  end
+
+  def self.from_string(string)
+    string.gsub(/\s+\n/, "\n").strip.force_encoding('UTF-8')
+  end
+end

data/lib/maremma/version.rb

@@ -1,3 +1,3 @@
 module Maremma
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/{base_spec.rb → maremma_spec.rb}

@@ -1,35 +1,36 @@
 require 'spec_helper'
 
-describe Maremma::Base do
+describe Maremma do
+  subject { Maremma }
   let(:url) { "http://example.org" }
   let(:data) { { "name" => "Fred" } }
   let(:post_data) { { "name" => "Jack" } }
 
-  context "get_result" do
+  context "get" 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_result(url)
+      response = subject.get(url)
       expect(response).to eq(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_result(url, content_type: 'xml')
+      response = subject.get(url, content_type: 'xml')
       expect(response).to eq('hash' => 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_result(url, content_type: 'html')
+      response = subject.get(url, content_type: 'html')
       expect(response).to eq(data.to_s)
       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 => data.to_xml, :status => 200, :headers => { "Content-Type" => "text/html" })
-      subject.get_result(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(Hash.from_xml(response.to_s)["hash"]).to eq(data) }
+      subject.get(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(Hash.from_xml(response.to_s)["hash"]).to eq(data) }
       expect(stub).to have_been_requested
     end
   end
@@ -37,28 +38,28 @@ describe Maremma::Base do
   context "empty response" do
     it "get json" do
       stub = stub_request(:get, url).to_return(:body => nil, :status => 200, :headers => { "Content-Type" => "application/json" })
-      response = subject.get_result(url)
+      response = subject.get(url)
       expect(response).to be_blank
       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_result(url, content_type: 'xml')
+      response = subject.get(url, content_type: 'xml')
       expect(response).to be_blank
       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_result(url, content_type: 'html')
+      response = subject.get(url, content_type: 'html')
       expect(response).to be_blank
       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.get_result(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
+      subject.get(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
       expect(stub).to have_been_requested
     end
   end
@@ -68,25 +69,25 @@ describe Maremma::Base do
 
     it "get json" do
       stub = stub_request(:get, url).to_return(:body => error.to_json, :status => [404], :headers => { "Content-Type" => "application/json" })
-      expect(subject.get_result(url)).to eq(error)
+      expect(subject.get(url)).to eq(error)
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_return(:body => error.to_xml, :status => [404], :headers => { "Content-Type" => "application/xml" })
-      expect(subject.get_result(url, content_type: 'xml')).to eq(error)
+      expect(subject.get(url, content_type: 'xml')).to eq(error)
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_return(:body => error.to_s, :status => [404], :headers => { "Content-Type" => "text/html" })
-      expect(subject.get_result(url, content_type: 'html')).to eq(error)
+      expect(subject.get(url, content_type: 'html')).to eq(error)
       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 => error.to_xml, :status => [404], :headers => { "Content-Type" => "application/xml" })
-      subject.get_result(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(Hash.from_xml(response.to_s)["hash"]).to eq(error) }
+      subject.get(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(Hash.from_xml(response.to_s)["hash"]).to eq(error) }
       expect(stub).to have_been_requested
     end
   end
@@ -94,28 +95,28 @@ describe Maremma::Base do
   context "request timeout" do
     it "get json" do
       stub = stub_request(:get, url).to_return(:status => [408])
-      response = subject.get_result(url)
+      response = subject.get(url)
       expect(response).to eq(error: "execution expired", status: 408)
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_return(:status => [408])
-      response = subject.get_result(url, content_type: 'xml')
+      response = subject.get(url, content_type: 'xml')
       expect(response).to eq(error: "execution expired", status: 408)
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_return(:status => [408])
-      response = subject.get_result(url, content_type: 'html')
+      response = subject.get(url, content_type: 'html')
       expect(response).to eq(error: "execution expired", status: 408)
       expect(stub).to have_been_requested
     end
 
     it "post xml" do
       stub = stub_request(:post, url).with(:body => post_data.to_xml).to_return(:status => [408])
-      subject.get_result(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
+      subject.get(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
       expect(stub).to have_been_requested
     end
   end
@@ -123,28 +124,28 @@ describe Maremma::Base do
   context "request timeout internal" do
     it "get json" do
       stub = stub_request(:get, url).to_timeout
-      response = subject.get_result(url)
+      response = subject.get(url)
       expect(response).to eq(error: "execution expired", status: 408)
       expect(stub).to have_been_requested
     end
 
     it "get xml" do
       stub = stub_request(:get, url).to_timeout
-      response = subject.get_result(url, content_type: 'xml')
+      response = subject.get(url, content_type: 'xml')
       expect(response).to eq(error: "execution expired", status: 408)
       expect(stub).to have_been_requested
     end
 
     it "get html" do
       stub = stub_request(:get, url).to_timeout
-      response = subject.get_result(url, content_type: 'html')
+      response = subject.get(url, content_type: 'html')
       expect(response).to eq(error: "execution expired", status: 408)
       expect(stub).to have_been_requested
     end
 
     it "post xml" do
       stub = stub_request(:post, url).with(:body => post_data.to_xml).to_timeout
-      subject.get_result(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
+      subject.get(url, content_type: 'xml', data: post_data.to_xml) { |response| expect(response).to be_nil }
       expect(stub).to have_been_requested
     end
   end
@@ -155,7 +156,7 @@ describe Maremma::Base do
     it "redirect" 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_result(url)
+      response = subject.get(url)
       expect(response).to eq("Test")
     end
 
@@ -165,7 +166,7 @@ describe Maremma::Base do
       stub_request(:get, redirect_url+ "/x").to_return(status: 301, headers: { location: redirect_url + "/y" })
       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_result(url)
+      response = subject.get(url)
       expect(response).to eq("Test")
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maremma
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Martin Fenner
@@ -249,10 +249,9 @@ files:
 - README.md
 - Rakefile
 - lib/maremma.rb
-- lib/maremma/base.rb
 - lib/maremma/version.rb
 - maremma.gemspec
-- spec/base_spec.rb
+- spec/maremma_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/datacite/maremma
 licenses:
@@ -279,5 +278,5 @@ signing_key:
 specification_version: 4
 summary: Simplified network calls
 test_files:
-- spec/base_spec.rb
+- spec/maremma_spec.rb
 - spec/spec_helper.rb

data/lib/maremma/base.rb

@@ -1,121 +0,0 @@
-require 'active_support/all'
-require 'json'
-require 'nokogiri'
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday/encoding'
-require 'excon'
-require 'uri'
-
-DEFAULT_TIMEOUT = 60
-NETWORKABLE_EXCEPTIONS = [Faraday::ClientError,
-                          Faraday::TimeoutError,
-                          Faraday::SSLError,
-                          Faraday::ConnectionFailed,
-                          URI::InvalidURIError,
-                          Encoding::UndefinedConversionError,
-                          ArgumentError,
-                          NoMethodError,
-                          TypeError]
-
-module Maremma
-  class Base
-    def get_result(url, content_type: 'json', headers: {}, **options)
-      conn = faraday_conn(content_type, options)
-      conn = auth_conn(conn, options)
-
-      conn.options[:timeout] = options[:timeout] || DEFAULT_TIMEOUT
-
-      # make sure we use a 'Host' header
-      headers['Host'] = URI.parse(url).host
-
-      if options[:data]
-        response = conn.post url, {}, headers do |request|
-          request.body = options[:data]
-        end
-      else
-        response = conn.get url, {}, headers
-      end
-      parse_response(response.body)
-    rescue *NETWORKABLE_EXCEPTIONS => error
-      rescue_faraday_error(error)
-    end
-
-    def faraday_conn(content_type = 'json', options = {})
-      # use short version for html, xml and json
-      content_types = { "html" => 'text/html; charset=UTF-8',
-                        "xml" => 'application/xml',
-                        "json" => 'application/json' }
-      accept_header = content_types.fetch(content_type, content_type)
-
-      # redirect limit
-      limit = options[:limit] || 10
-
-      Faraday.new do |c|
-        c.headers['Accept'] = accept_header
-        c.headers['User-Agent'] = "spinone - http://#{ENV['HOSTNAME']}"
-        c.use      FaradayMiddleware::FollowRedirects, limit: limit, cookie: :all
-        c.request  :multipart
-        c.request  :json if accept_header == 'application/json'
-        c.use      Faraday::Response::RaiseError
-        c.response :encoding
-        c.adapter  :excon
-      end
-    end
-
-    def auth_conn(conn, options)
-      if options[:bearer]
-        conn.authorization :Bearer, options[:bearer]
-      elsif options[:token]
-        conn.authorization :Token, token: options[:token]
-      elsif options[:username]
-        conn.basic_auth(options[:username], options[:password])
-      end
-      conn
-    end
-
-    def rescue_faraday_error(error)
-      if error.is_a?(Faraday::ResourceNotFound)
-        { error: "resource not found", status: 404 }
-      elsif error.is_a?(Faraday::TimeoutError) || error.is_a?(Faraday::ConnectionFailed) || (error.try(:response) && error.response[:status] == 408)
-        { error: "execution expired", status: 408 }
-      else
-        { error: parse_error_response(error.message), status: 400 }
-      end
-    end
-
-    def parse_error_response(string)
-      string = parse_response(string)
-
-      if string.is_a?(Hash) && string['error']
-        string['error']
-      else
-        string
-      end
-    end
-
-    def parse_response(string)
-      from_json(string) || from_xml(string) || from_string(string)
-    end
-
-    protected
-
-    def from_xml(string)
-      if Nokogiri::XML(string).errors.empty?
-        Hash.from_xml(string)
-      else
-        nil
-      end
-    end
-
-    def from_json(string)
-      JSON.parse(string)
-    rescue JSON::ParserError
-      nil
-    end
-
-    def from_string(string)
-      string.gsub(/\s+\n/, "\n").strip.force_encoding('UTF-8')
-    end
-  end
-end