grac 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b337c7fac688e4f60d466b5d78cf6929d8cac450
+  data.tar.gz: 6d973b76148b08844fe8055f00f952fdcd581a54
+SHA512:
+  metadata.gz: cc37a4bec5a5c21f58b8cb71f76dafbaf9330c6cce6be5652a0a24ed153128efff2056459b0543494ae19c0fc9016bfc3239a93a02d75d19102ae30a0afb0246
+  data.tar.gz: 196fd93ad92112b1634fc6478a90a35caa98705d6d8efd14bcbe2c44a96dc8ad5378ee1383189fc934f72ec81891f88958e1dfd6aa493a35f42bcfa4b292b9c8

data/lib/grac.rb

@@ -0,0 +1,2 @@
+require 'grac/version'
+require 'grac/client'

data/lib/grac/client.rb

@@ -0,0 +1,132 @@
+require 'json'
+require 'typhoeus'
+require 'uri'
+
+require_relative './exception'
+require_relative './response'
+
+module Grac
+  class Client
+    attr_reader :uri
+
+    def initialize(uri, options = {})
+      URI.parse(uri)
+
+      @uri = uri
+      @options = {
+        :connecttimeout => options[:connecttimeout] || 0.1,
+        :timeout        => options[:timeout]        || 15,
+        :params         => options[:params]         || {},
+        :headers        => { "User-Agent" => "Grac v#{Grac::VERSION}" }.merge(options[:headers] || {}),
+        :postprocessing => options[:postprocessing] || {}
+      }
+    end
+
+    def set(options = {})
+      options = options.merge({
+        headers: @options[:headers].merge(options[:headers] || {})
+      })
+
+      self.class.new(@uri, @options.merge(options))
+    end
+
+    def path(path, variables = {})
+      variables.each do |key, value|
+        path = path.gsub("{#{key}}", value)
+      end
+      self.class.new("#{@uri}#{path}", @options)
+    end
+
+    %w{post put patch}.each do |method|
+      define_method method do |body = {}, params = {}|
+        request = build_request(method, { :body => body, :params => params })
+        run(request)
+      end
+    end
+
+    %w{get delete}.each do |method|
+      define_method method do |params = {}|
+        request = build_request(method, { :params => params })
+        run(request)
+      end
+    end
+
+    private
+      def build_request(method, options = {})
+        body = options[:body].nil? || options[:body].empty? ? nil : options[:body].to_json
+
+        request_hash = { :method => method }
+        request_hash[:params]         = @options[:params].merge(options[:params] || {})
+        request_hash[:body]           = body
+        request_hash[:connecttimeout] = @options[:connecttimeout]
+        request_hash[:timeout]        = @options[:timeout]
+        request_hash[:headers]        = @options[:headers]
+
+        return ::Typhoeus::Request.new(uri, request_hash)
+      end
+
+      def postprocessing(data, processing = nil)
+        return data if @options[:postprocessing].nil? || @options[:postprocessing].empty?
+
+        if data.kind_of?(Hash)
+          data.each do |key, value|
+            processing = nil
+            @options[:postprocessing].each do |regex, action|
+              if /#{regex}/ =~ key
+                processing = action
+              end
+            end
+
+            data[key] = postprocessing(value, processing)
+          end
+        elsif data.kind_of?(Array)
+          data.each_with_index do |value, index|
+            data[index] = postprocessing(value, processing)
+          end
+        else
+          data = processing.nil? ? data : processing.call(data)
+        end
+
+        return data
+      end
+
+      def run(request)
+        response = request.run
+
+        # Retry GET and HEAD requests - modifying requests might not be idempotent
+        method = request.options[:method].to_s.downcase
+        response = request.run if response.timed_out? && ['get', 'head'].include?(method)
+
+        # A request can time out while receiving data. In this case response.code might indicate
+        # success although data hasn't been fully transferred. Thus rely on Typhoeus for
+        # detecting a timeout.
+        if response.timed_out?
+          raise Exception::ServiceTimeout.new(method, request.url, response.return_message)
+        end
+
+        grac_response = Response.new(response)
+        case response.code
+          when 200, 201
+            if grac_response.json_content?
+              return postprocessing(grac_response.parsed_json)
+            end
+
+            return grac_response.body
+          when 204
+            return true
+          when 0
+            raise Exception::RequestFailed.new(method, request.url, response.return_message)
+          when 400
+            raise Exception::BadRequest.new(method, request.url, grac_response.parsed_or_raw_body)
+          when 403
+            raise Exception::Forbidden.new(method, request.url, grac_response.parsed_or_raw_body)
+          when 404
+            raise Exception::NotFound.new(method, request.url, grac_response.parsed_or_raw_body)
+          when 409
+            raise Exception::Conflict.new(method, request.url, grac_response.parsed_or_raw_body)
+          else
+            raise Exception::ServiceError.new(method, request.url, grac_response.parsed_or_raw_body)
+        end
+      end
+  end
+end

data/lib/grac/exception.rb

@@ -0,0 +1,74 @@
+require 'json'
+
+module Grac
+  module Exception
+    class ClientException < StandardError
+      attr_reader :url, :method, :body
+
+      def initialize(method, url, body)
+        @method    = (method || "").upcase
+        @url       = url
+        @body      = body
+      end
+
+      def inspect
+        "#{self.class.name}: #{message}"
+      end
+
+      def message
+        "#{@method} '#{@url}' failed with content: #{@body}"
+      end
+
+      alias_method :to_s, :message
+    end
+
+    class BadRequest   < ClientException; end
+    class Forbidden    < ClientException; end
+    class NotFound     < ClientException; end
+    class Conflict     < ClientException; end
+    class ServiceError < ClientException; end
+
+    class RequestFailed  < StandardError
+      attr_reader :method, :url
+
+      def initialize(method, url, message)
+        @method  = (method || "").upcase
+        @url     = url
+        @message = message
+      end
+
+      def message
+        "#{@method} '#{@url}' failed: #{@message}"
+      end
+
+      def inspect
+        "#{self.class.name}: #{message}"
+      end
+
+      alias_method :to_s, :message
+    end
+
+    class ServiceTimeout < RequestFailed
+      def message
+         "#{@method} '#{@url}' timed out: #{@message}"
+      end
+    end
+
+    class InvalidContent < StandardError
+      def initialize(body, type)
+        @body = body
+        @type = type
+      end
+
+      def message
+        "Failed to parse body as '#{@type}': '#{@body}'"
+      end
+
+      def inspect
+        "#{self.class.name}: #{message}"
+      end
+
+      alias_method :to_s, :message
+    end
+  end
+end

data/lib/grac/response.rb

@@ -0,0 +1,39 @@
+require 'json'
+
+require_relative './exception'
+
+module Grac
+  class Response
+    extend Forwardable
+
+    def_delegator :@response, :body
+
+    def initialize(typhoeus_response)
+      @response = typhoeus_response
+    end
+
+    def content_type
+      @response.headers["Content-Type"]
+    end
+
+    def json_content?
+      !content_type.nil? && content_type.match('application/json')
+    end
+
+    def parsed_json
+      JSON.parse(body)
+    rescue JSON::ParserError
+      raise Exception::InvalidContent.new(body, 'json')
+    end
+
+    def parsed_or_raw_body
+      return body unless json_content?
+
+      begin
+        parsed_json
+      rescue Exception::InvalidContent
+        body
+      end
+    end
+  end
+end

data/lib/grac/version.rb

@@ -0,0 +1,3 @@
+module Grac
+  VERSION = "2.0.1"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: grac
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- Tobias Schoknecht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+description: Generic REST API Client
+email:
+- tobias.schoknecht@barzahlen.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/grac.rb
+- lib/grac/client.rb
+- lib/grac/exception.rb
+- lib/grac/response.rb
+- lib/grac/version.rb
+homepage: https://github.com/Barzahlen/grac
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Very generic client for REST API with basic error handling
+test_files: []