namira 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd40f31fd9c696c000f54eeb83a09db3c4213222
-  data.tar.gz: a707df33c8946cb12d735e7ba9ec5204c54ae3fc
+SHA256:
+  metadata.gz: 61aed0e8cd917b38eb9eb293a3ed95331aa79066c08e1230fd517335bfe4a9c4
+  data.tar.gz: 129c02c6bb5a4fdaad7d1f91fd6f7ea1f6811ce30d6d20cb3f5b995954742e0a
 SHA512:
-  metadata.gz: 8149d922e3f943da4717c04df6aca73d51b27a8a45e69108e37b2d47bb35624e31638df989ca102b7288bb9c2524938509a7e1263406dd957357b1edf62b54c4
-  data.tar.gz: faca22f4f42291a472e2c19486b2953648e9dd29116a9f49b282d96eee27906b87994b89f7e240dcead130e357d88d67399145cc769179a9dd0bc65edfb134c2
+  metadata.gz: 847929dfe0d91112e5d54f6b8f0a3889ea9b2f0245e556d22d6c6b5681aa3ba97cf2c503c055e4fd118c0036c9c45cc3d8e1b3ab16edbea0775066f4603471ca
+  data.tar.gz: d4db9832c632cc6b299484ca7116236d9792dfec85ca569a5b747670bfd76fa26c9fe92754225df4efab01325f6bb3cc75bdc253f781f89fcc18a4d911819b2c

data/.rubocop.yml

@@ -1,8 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
   Exclude:
     - Rakefile
-    - spec/**/*
 
 Metrics/AbcSize:
   Max: 30
@@ -19,6 +18,11 @@ Metrics/ParameterLists:
 Metrics/CyclomaticComplexity:
   Max: 10
 
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
 DotPosition:
   EnforcedStyle: leading
 

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.3 (2019-02-06)
+
+* Support for async requests. Supports ActiveJob and plain Sidekiq.
+
 # 1.2 (2019-01-18)
 
 * Auto add Bugsnag error information

data/lib/namira.rb

@@ -1,3 +1,4 @@
+require 'namira/async'
 require 'namira/config'
 require 'namira/env'
 require 'namira/error_helpers'

data/lib/namira/async.rb

@@ -0,0 +1,5 @@
+require_relative 'async/active_job/request_job' if defined?(::ActiveJob)
+require_relative 'async/sidekiq/request_worker' if defined?(::Sidekiq)
+
+require_relative 'async/performer'
+require_relative 'async/serializer'

data/lib/namira/async/active_job/request_job.rb

@@ -0,0 +1,13 @@
+require_relative '../performer'
+
+module Namira
+  module Async
+    module ActiveJob
+      class RequestJob < ::ActiveJob::Base
+        def perform(payload)
+          Namira::Async::Performer.perform(payload)
+        end
+      end
+    end
+  end
+end

data/lib/namira/async/performer.rb

@@ -0,0 +1,47 @@
+require_relative 'serializer'
+require_relative '../config'
+require_relative '../errors'
+
+module Namira
+  module Async
+    class Performer
+      class << self
+        def schedule(request, async_adapter, queue_name)
+          async_adapter = adapter(async_adapter)
+          queue_name ||= Namira.config.async_queue_name
+          payload = Namira::Async::Serializer.serialize_request(request)
+
+          case async_adapter
+          when :active_job
+            Namira::Async::ActiveJob::RequestJob.set(queue: queue_name).perform_later(payload)
+          when :sidekiq
+            Namira::Async::Sidekiq::RequestWorker.set(queue: queue_name).perform_async(payload)
+          when :thread
+            Thread.new { perform(payload) }
+          else
+            raise Namira::Errors::AsyncError, "Unknown Async Adapter #{async_adapter}"
+          end
+        end
+
+        def perform(payload)
+          request = Namira::Async::Serializer.unserialize_request(payload)
+          request.send_request
+          Namira::Async::Serializer.serialize_response(request.response)
+        end
+
+        private
+
+        def adapter(async_adapter)
+          async_adapter ||= Namira.config.async_adapter
+          if async_adapter == :active_job && !defined?(ActiveJob)
+            adapter(:sidekiq)
+          elsif async_adapter == :sidekiq && !defined?(Sidekiq)
+            adapter(:thread)
+          else
+            async_adapter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/namira/async/serializer.rb

@@ -0,0 +1,61 @@
+require_relative '../errors'
+
+module Namira
+  module Async
+    class Serializer
+      class << self
+        def serialize_request(request)
+          JSON.dump(
+            u: request.uri,
+            m: request.http_method,
+            h: request.headers.to_h,
+            b: request.body,
+            c: request.config.to_h
+          )
+        end
+
+        def unserialize_request(payload)
+          data = JSON.parse(payload)
+          Namira::Request.new(
+            uri: data.fetch('u'),
+            http_method: data.fetch('m').to_sym,
+            headers: data.fetch('h'),
+            body: data.fetch('b'),
+            config: data.fetch('c')
+          )
+        rescue KeyError => error
+          raise Namira::Errors::AsyncError, error.message
+        end
+
+        def serialize_response(response)
+          backing = response.instance_variable_get('@backing')
+          JSON.dump(
+            b: backing.to_a,
+            m: response.method,
+            r: response.redirect_count,
+            u: response.url.to_s,
+            v: backing.instance_variable_get('@version')
+          )
+        end
+
+        def unserialize_response(payload)
+          data = JSON.parse(payload)
+          backing = HTTP::Response.new(
+            status: data.fetch('b')[0],
+            headers: data.fetch('b')[1],
+            body: data.fetch('b')[2],
+            version: data.fetch('v')
+          )
+          Namira::Response.new(
+            data.fetch('m').to_sym,
+            Addressable::URI.parse(data.fetch('u')),
+            data.fetch('r').to_i,
+            backing
+          )
+        rescue KeyError => error
+          raise Namira::Errors::AsyncError, error.message
+        end
+      end
+    end
+  end
+end

data/lib/namira/async/sidekiq/request_worker.rb

@@ -0,0 +1,15 @@
+require_relative '../performer'
+
+module Namira
+  module Async
+    module ActiveJob
+      class RequestWorker
+        include Sidekiq::Worker
+
+        def perform(payload)
+          Namira::Async::Performer.perform(payload)
+        end
+      end
+    end
+  end
+end

data/lib/namira/config.rb

@@ -30,11 +30,20 @@ module Namira
   #
   # @!attribute [r] headers
   #   Default headers to send with each request
-  #   @return [OpenStruct]
+  #   @return [Hash]
   #
   # @!attribute [rw] log_requests
   #   Log requests using puts or Rails.logger.debug if it's defined
   #   @return (Bool) Defaults: true
+  #
+  # @!attribute [rw] async_queue_name
+  #   The queue name that async requests should be added too.
+  #   @return [Symbol] Defaults: :default
+  #
+  # @!attribute [rw] async_adapter
+  #   The preferred async adapter to use.
+  #   Possible Values: :active_job, :sidekiq
+  #   @return [Symbol] Defaults: :active_job
   class Config < OpenStruct
     ##
     # The
@@ -45,11 +54,13 @@ module Namira
 
     DEFAULT_SETTINGS = {
       max_redirect: 3,
-      timeout:      5.0,
-      backend:      nil,
-      user_agent:   "Namira/#{Namira::VERSION}",
-      headers:      OpenStruct.new,
-      log_requests: true
+      timeout: 5.0,
+      backend: nil,
+      user_agent: "Namira/#{Namira::VERSION}",
+      headers: {},
+      log_requests: true,
+      async_queue_name: :default,
+      async_adapter: :active_job
     }.freeze
 
     private_constant :DEFAULT_SETTINGS
@@ -62,8 +73,12 @@ module Namira
   ##
   # The shared configuration
   def self.configure
+    yield(config) if block_given?
+    config
+  end
+
+  def self.config
     @config ||= Config.new
-    yield(@config) if block_given?
     @config
   end
 end

data/lib/namira/error_helpers.rb

@@ -17,13 +17,12 @@ if defined?(::Bugsnag)
           notification.exceptions.each do |exception|
             next unless exception.is_a?(Namira::Errors::HTTPError)
 
-            notification.add_tab("Namira #{exception.response.status.to_i}", {
+            notification.add_tab("Namira #{exception.response.status.to_i}",
               headers: exception.response.headers.to_h,
               body: exception.response.body.to_s[0...200],
               method: exception.response.method.to_s,
               url: exception.response.url.to_s,
-              redirected: (exception.response.redirect_count > 0).to_s
-            })
+              redirected: (exception.response.redirect_count > 0).to_s)
           end
 
           @bugsnag.call(notification)

data/lib/namira/errors.rb

@@ -1,4 +1,5 @@
 require_relative 'errors/base_error'
+require_relative 'errors/async_error'
 require_relative 'errors/http_error'
 require_relative 'errors/invalid_uri_error'
 require_relative 'errors/redirect_error'

data/lib/namira/errors/async_error.rb

@@ -0,0 +1,8 @@
+module Namira
+  module Errors
+    ##
+    # An async API error
+    class AsyncError < BaseError
+    end
+  end
+end

data/lib/namira/errors/http_error.rb

@@ -87,7 +87,7 @@ module Namira
         '415' => 'Unsupported Media Type',
         '416' => 'Range Not Satisfiable',
         '417' => 'Expectation Failed',
-        '418' => "Im A Teapot",
+        '418' => 'Im A Teapot',
         '421' => 'Misdirected Request',
         '422' => 'Unprocessable Entity',
         '423' => 'Locked',

data/lib/namira/middleware/config.rb

@@ -19,7 +19,7 @@ module Namira
       private
 
       def merge_config(config)
-        Namira.configure.to_h.merge(config)
+        Namira.config.to_h.merge(config)
       end
     end
   end

data/lib/namira/middleware/header.rb

@@ -12,7 +12,7 @@ module Namira
       #
       # @param env [Namira::Env] The request environment
       def call(env)
-        headers = Hash(Namira.configure.headers.to_h).dup
+        headers = Hash(Namira.config.headers.to_h).dup
         headers.merge!(additional_headers(env))
         headers.merge!(env.headers.to_h)
         env.headers = convert_headers(headers)

data/lib/namira/middleware/logger.rb

@@ -23,15 +23,16 @@ module Namira
       private
 
       def logging?(env)
-        if env.config.keys.include?(SKIP_LOGGING_KEY)
+        if env.config.key?(SKIP_LOGGING_KEY)
           env.config[SKIP_LOGGING_KEY] == false
         else
-          Namira.configure.log_requests == true
+          Namira.config.log_requests == true
         end
       end
 
       def log_request(env)
         return unless logging?(env)
+
         message = "#{env.method.to_s.upcase} - #{env.uri}"
         if defined?(::Rails)
           Rails.logger.debug(message)

data/lib/namira/middleware/network.rb

@@ -15,9 +15,9 @@ module Namira
         timeout = env.config[:timeout] || 30.0
         http = HTTP.timeout(
           :per_operation,
-          write:   timeout,
+          write: timeout,
           connect: timeout,
-          read:    timeout
+          read: timeout
         )
         http = http.headers(env.headers)
         env.response = http.send(env.method, env.uri, body: env.body)

data/lib/namira/middleware/redirector.rb

@@ -59,6 +59,7 @@ module Namira
 
       def redirect?(error, env)
         return false unless env.config[:follow_redirect].nil? ? true : env.config[:follow_redirect]
+
         REDIRECT_STATUS.include?(error.status)
       end
     end

data/lib/namira/request.rb

@@ -1,4 +1,5 @@
 require 'http'
+require_relative 'async'
 
 module Namira
   ##
@@ -6,7 +7,7 @@ module Namira
   #
   #   response = Namira::Request.new(uri: 'https://httpbin.org/headers').response
   class Request
-    attr_reader :uri, :http_method
+    attr_reader :uri, :http_method, :headers, :body, :config
 
     ##
     # Create a new request
@@ -21,7 +22,7 @@ module Namira
       @http_method = http_method
       @headers     = Hash(headers)
       @body        = body
-      @config      = Namira.configure.to_h.merge(Hash(config))
+      @config      = Namira.config.to_h.merge(Hash(config))
       @stack       = Namira::Stack.default
     end
 
@@ -33,6 +34,10 @@ module Namira
       @response = _send_request
     end
 
+    def send_async(queue_name: nil, adapter: nil)
+      Namira::Async::Performer.schedule(self, adapter, queue_name)
+    end
+
     ##
     # The {Namira::Response} for the request.
     #

data/lib/namira/response.rb

@@ -1,3 +1,5 @@
+require_relative 'async/serializer'
+
 module Namira
   ##
   # HTTP response
@@ -8,6 +10,10 @@ module Namira
 
     attr_reader :redirect_count
 
+    def self.serialized(raw_response)
+      Namira::Async::Serializer.unserialize_response(raw_response)
+    end
+
     ##
     # Create a new {Namira::Response}
     def initialize(method, url, redirect_count, backing)

data/lib/namira/stack.rb

@@ -30,6 +30,7 @@ module Namira
     # @param env [Namira::Env] The request environment
     def call(env)
       raise ArgumentError, 'Invalid environment' unless env.is_a?(Namira::Env)
+
       to_app.call(env)
     end
 

data/lib/namira/version.rb

@@ -1,5 +1,5 @@
 module Namira
   ##
   # The current version of Namira
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/namira.gemspec

@@ -18,15 +18,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2'
+  spec.required_ruby_version = '>= 2.3'
 
   spec.add_dependency 'http', '>= 2.0.0', '< 4.0'
 
-  spec.add_development_dependency 'bundler',        '~> 1.15'
-  spec.add_development_dependency 'pry',            '~> 0.11.3'
-  spec.add_development_dependency 'rake',           '~> 10.0'
-  spec.add_development_dependency 'rspec',          '~> 3.2'
-  spec.add_development_dependency 'simplecov',      '~> 0.15'
-  spec.add_development_dependency 'webmock',        '~> 3.3.0'
-  spec.add_development_dependency 'yard',           '~> 0.9'
+  spec.add_development_dependency 'bundler',   '~> 1.15'
+  spec.add_development_dependency 'pry',       '~> 0.11.3'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'sinatra',   '~> 2.0.5'
+  spec.add_development_dependency 'webmock',   '~> 3.3.0'
+  spec.add_development_dependency 'yard',      '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namira
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Skylar Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +153,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -148,10 +163,16 @@ files:
 - bin/console
 - bin/setup
 - lib/namira.rb
+- lib/namira/async.rb
+- lib/namira/async/active_job/request_job.rb
+- lib/namira/async/performer.rb
+- lib/namira/async/serializer.rb
+- lib/namira/async/sidekiq/request_worker.rb
 - lib/namira/config.rb
 - lib/namira/env.rb
 - lib/namira/error_helpers.rb
 - lib/namira/errors.rb
+- lib/namira/errors/async_error.rb
 - lib/namira/errors/base_error.rb
 - lib/namira/errors/http_error.rb
 - lib/namira/errors/invalid_uri_error.rb
@@ -184,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -192,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simple wrapper around HTTP