namira 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73a718a6245b965921781bcabdf93ce29f5e892a
-  data.tar.gz: 427e8a0b459c7c48103faacc44576272ffe3a661
+  metadata.gz: ceb147177963eed28f00f95af29fc6a946ec3183
+  data.tar.gz: d0e5fee286e28d249b4df0c6e3b1c2367df9f6f0
 SHA512:
-  metadata.gz: 842ea8719b57163910152d814a01193882b7d5f0d24c9d463cb6d456c4436ed90c774fe51b60bbbdab751389779210623f77ed01444d4adbc91909811456b309
-  data.tar.gz: 1322d55a14aa409eb316dd91791f07a00abd886ec8373ab1e97c2b0cd7a66a9a9e79e04bf0bb904d9f897dfbda9f42c0aef4f9a425d5844a582abe658a666e32
+  metadata.gz: 1834e46264ca4cd04af564c1e5ea9ef78b1f99a077603f4b6d8d20ac5f844485764cb87f6cb43f8c064b67c9d39052bccd3b2d6ab84f797ae92d65f0a19bf622
+  data.tar.gz: 313fabbb4fb844d96f8036e304498800f4a1442f27ff323c15fa21f52c52600c743e193465eb3c5090ae87bb7173455e0a7018973fdc282f4907a5fa6cb668bf

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - Rakefile
+    - bin/**/*
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+DotPosition:
+  EnforcedStyle: leading
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false

data/lib/namira.rb

@@ -6,5 +6,6 @@ require 'namira/config'
 require 'namira/query_builder'
 require 'namira/backend'
 require 'namira/extensions/hash_key_path'
+require 'namira/auth'
 
 Hash.include(Namira::Extensions::HashKeyPath)

data/lib/namira/auth.rb

@@ -0,0 +1,2 @@
+require_relative 'auth/base'
+require_relative 'auth/http_basic'

data/lib/namira/auth/base.rb

@@ -0,0 +1,24 @@
+module Namira
+  module Auth
+    class Base
+      attr_accessor :sign_redirects
+
+      def sign_redirects?
+        if @sign_redirects.nil?
+          true
+        else
+          @sign_redirects == true
+        end
+      end
+
+      def sign_request(backend, redirect_count)
+        return if redirect_count > 0 && !sign_redirects?
+        sign(backend)
+      end
+
+      def sign(_backend)
+        raise NotImplementedError, 'Auth should override the `sign` method'
+      end
+    end
+  end
+end

data/lib/namira/auth/http_basic.rb

@@ -0,0 +1,16 @@
+module Namira
+  module Auth
+    class HTTPBasic < Base
+      attr_reader :user, :pass
+
+      def initialize(user:, pass:)
+        @user = user
+        @pass = pass
+      end
+
+      def sign(request)
+        request.basic_auth(user: user, pass: pass)
+      end
+    end
+  end
+end

data/lib/namira/backend.rb

@@ -1,10 +1,9 @@
 module Namira
   class Backend
-
     #
     # This allows anyone to substitute in their own networking stack.
     #
-    # Any class that implements this method and resturns a `Namira::Response` object can be a fully qualified backend
+    # Any class that implements this method and resturns a `Namira::Response` object can be a fully qualified backend.
     #
     # The required params are
     #
@@ -13,30 +12,29 @@ module Namira
     #  headers:      The full HTTP headers to send from the request expressed as a Hash
     #  max_redirect: The maximum number of redirects to follow.  Passed from the Request
     #  timeout:      The number of seconds before a timeout should occure
+    #  auth:         The Namira::Auth::Base subclass instance or nil to sign the request with
     #
-    # This class is 100% capable of fufilling all Namira's needs.  But this is an option if you really need to provide a custom networking backend
+    # This class is 100% capable of fufilling all Namira's needs.
+    # But this is an option if you really need to provide a custom networking backend
     #
-    def self.send_request(uri:, method:, headers:, max_redirect:, timeout:, body:)
-      Backend.new.send_request(uri, method, headers, max_redirect, timeout, body)
+    def self.send_request(uri:, method:, headers:, max_redirect:, timeout:, body:, auth:)
+      Backend.new.send_request(uri, method, headers, max_redirect, timeout, body, auth)
     end
 
-    def send_request(uri, method, headers, max_redirect, timeout, body)
+    def send_request(uri, method, headers, max_redirect, timeout, body, auth)
       @redirect_count ||= 0
-      fail Errors::TooManyRedirects, "Max number of redirects #{@redirect_count} for #{uri}" if @redirect_count > max_redirect
+      raise Errors::TooManyRedirects, "Max number of redirects #{@redirect_count} for #{uri}" if @redirect_count > max_redirect
 
-      if defined?(::Rails)
-        Rails.logger.debug "#{method.to_s.upcase} - #{uri}"
-      else
-        puts "#{method.to_s.upcase} - #{uri}"
-      end
+      log_request(method, uri)
 
       http = HTTP.timeout(
-          :per_operation,
-          write:   timeout,
-          connect: timeout,
-          read:    timeout
-        )
-        .headers(headers)
+        :per_operation,
+        write:   timeout,
+        connect: timeout,
+        read:    timeout
+      ).headers(headers)
+
+      http = auth.sign_request(http, @redirect_count) unless auth.nil?
 
       response = http.send(method, uri, body: body)
 
@@ -46,14 +44,24 @@ module Namira
       when 301, 302
         @redirect_count += 1
         location = response.headers['Location']
-        fail Errors::RedirectError, "Request redirected but no location was supplied" if location.nil?
+        raise Errors::RedirectError, 'Request redirected but no location was supplied' if location.nil?
         send_request(location, method, headers, max_redirect, timeout, body)
       else
-        fail Errors::HTTPError.new("http_error/#{response.status}", response.status)
+        raise Errors::HTTPError.new("http_error/#{response.status}", response.status)
       end
 
     rescue HTTP::TimeoutError => e
-      fail Namira::Errors::Timeout.new(e.message)
+      raise Namira::Errors::Timeout.new(e.message)
+    end
+
+    private
+
+    def log_request(method, uri)
+      if defined?(::Rails)
+        Rails.logger.debug "#{method.to_s.upcase} - #{uri}"
+      else
+        puts "#{method.to_s.upcase} - #{uri}"
+      end
     end
   end
 end

data/lib/namira/config.rb

@@ -7,26 +7,16 @@ module Namira
       timeout:      5.0,
       backend:      nil,
       user_agent:   "Namira/#{Namira::VERSION}"
-    }
+    }.freeze
 
     def initialize
       DEFAULT_SETTINGS.each do |k, v|
-        self.send("#{k}=", v)
+        send("#{k}=", v)
       end
     end
 
     def headers
-      @headers ||= ConfigHash.new
-    end
-  end
-
-  class ConfigHash < Hash
-    def method_missing(name, *args)
-      if name.to_s =~ /=$/
-        self[name.to_s.gsub(/=$/, '')] = args.first
-      else
-        self[name]
-      end
+      @headers ||= OpenStruct.new
     end
   end
 

data/lib/namira/errors/base.rb

@@ -1,7 +1,6 @@
 module Namira
   module Errors
     class Base < StandardError
-
     end
   end
 end

data/lib/namira/errors/timeout.rb

@@ -1,7 +1,6 @@
 module Namira
   module Errors
     class Timeout < Base
-
     end
   end
 end

data/lib/namira/errors/too_many_redirects.rb

@@ -1,7 +1,6 @@
 module Namira
   module Errors
     class TooManyRedirects < Base
-
     end
   end
 end

data/lib/namira/extensions/hash_key_path.rb

@@ -8,13 +8,11 @@ module Namira
           break if value.nil?
 
           value = case value
-          when Hash
-            value[key] || value[key.to_sym]
-          when Array
-            value[key.to_i]
-          else
-            nil
-          end
+                  when Hash
+                    value[key] || value[key.to_sym]
+                  when Array
+                    value[key.to_i]
+                  end
         end
         value
       end

data/lib/namira/query_builder.rb

@@ -1,19 +1,7 @@
 module Namira
-  class QueryBuilder
-    def initialize
-      @backing = {}
-    end
-
-    def method_missing(name, *args)
-      if name.to_s =~ /=$/
-        @backing[name.to_s.gsub(/=$/, '')] = args.first
-      else
-        @backing[name.to_s]
-      end
-    end
-
+  class QueryBuilder < OpenStruct
     def to_s
-      @backing.map { |k, v| "#{k}=#{v}" }.join('&')
+      to_h.map { |k, v| "#{k}=#{v}" }.join('&')
     end
   end
 end

data/lib/namira/request.rb

@@ -4,11 +4,12 @@ module Namira
   class Request
     attr_reader :uri, :http_method
 
-    def initialize(uri:, http_method: :get, headers: {}, body: nil)
+    def initialize(uri:, http_method: :get, headers: {}, body: nil, auth: nil)
       @uri          = uri
       @http_method  = http_method
       @headers      = headers || {}
       @body         = body
+      @auth         = auth
       @timeout      = Namira.configure.timeout
       @max_redirect = Namira.configure.max_redirect
       @backend      = Namira.configure.backend || Namira::Backend
@@ -29,7 +30,7 @@ module Namira
       {}.tap do |headers|
         headers['User-Agent'] = @user_agent
         Namira.configure.headers.each do |k, v|
-          key = k.split('_').map { |s| s.capitalize }.join('-')
+          key = k.split('_').map(&:capitalize).join('-')
           headers[key] = v
         end
         @headers.each do |k, v|
@@ -45,7 +46,8 @@ module Namira
         headers:      build_headers,
         max_redirect: @max_redirect,
         timeout:      @timeout,
-        body:         @body
+        body:         @body,
+        auth:         @auth
       )
     end
   end

data/lib/namira/response.rb

@@ -15,5 +15,9 @@ module Namira
         super
       end
     end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @bakcing.respond_to?(method_name) || super
+    end
   end
 end

data/lib/namira/version.rb

@@ -1,3 +1,3 @@
 module Namira
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/namira.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namira
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Skylar Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -103,6 +104,9 @@ files:
 - bin/console
 - bin/setup
 - lib/namira.rb
+- lib/namira/auth.rb
+- lib/namira/auth/base.rb
+- lib/namira/auth/http_basic.rb
 - lib/namira/backend.rb
 - lib/namira/config.rb
 - lib/namira/errors.rb