endpoint-flux 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0274fa91a530211dfb8293bd9663d74c67e57eab95c593b2a21187333f6f563a
-  data.tar.gz: 2ca3e41032810c54268440850141b22dff6c8ac868c134bfb85ddbd523b5474a
+  metadata.gz: d3d775f0aa474f44316f38322c81f8c2719659c6b88bd0ea4e363c1c4e3719c9
+  data.tar.gz: cbc3962cba9f2c453a6fa68b570108a80aeffdda33a00bb6f2607faa58699361
 SHA512:
-  metadata.gz: dc4fe82a415890d4b207dfba40193c4e600b78f96f6bf49b0146203ec3f8e9b01d2682316ae0a037f859df77c2cc11c3026ce37b5399506bbcb126f1ba4762e6
-  data.tar.gz: ba45e125f2a8508e5fc62a216af336dcc4f84bcc8afeeb57cdca4c2cce8115b9fc448614d16d16c485056a85908184c75b1add80928895d31e1b789a1df60338
+  metadata.gz: 6babb40f498026c950cbee97e8d7cd9971bbc8b1c88552606d410e318ac5522807e03c8669682772a3a3ebca6a50439d0a69399d60df081e5b2ff5f6bb9843b2
+  data.tar.gz: 4a065804095484a0ec712aae7898b123d5ad0ab0478ce641da1d42d2288ba71a7905fe216dadd73e0e36b3e1ac03bb22926ff9e2455bdc3dbf9882ef10c48d50

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    endpoint-flux (1.1.1)
+    endpoint-flux (1.1.2)
 
 GEM
   remote: https://rubygems.org/

data/endpoint_flux.gemspec

@@ -5,13 +5,14 @@ Gem::Specification.new do |s|
   s.version       = EndpointFlux::VERSION
   s.summary       = 'EndpointFlux!'
   s.description   = 'A simple way to organise API endpoints'
-  s.authors       = ['Arturs Kreipans']
+  s.authors       = ['Arturs Kreipans https://github.com/fragallia']
   s.files         = `git ls-files`.split($\)
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
   s.homepage      = 'http://rubygems.org/gems/endpoint-flux'
   s.license       = 'MIT'
+  s.required_ruby_version = '~> 2.5'
 
-  s.add_development_dependency 'byebug'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'byebug' '~> 9.0'
+  s.add_development_dependency 'rspec' '~> 3.5'
 end

data/lib/endpoint_flux/rails/concerns/endpoint_controller.rb

@@ -19,6 +19,7 @@ module EndpointFlux
         def request_object
           ::EndpointFlux::Request.new(
             headers: headers.merge('Authorization' => request.headers['authorization']),
+            remote_ip: remote_ip,
             params: endpoint_params
           )
         end
@@ -26,6 +27,16 @@ module EndpointFlux
         def endpoint_params
           params.permit!.except(:controller, :action, :format).to_h.deep_symbolize_keys
         end
+
+        def remote_ip
+          ip = request.remote_ip.to_s
+
+          if ip == '127.0.0.1'
+            ip = request.env['HTTP_X_FORWARDED_FOR']
+          end
+
+          ip
+        end
       end
     end
   end

data/lib/endpoint_flux/request.rb

@@ -1,13 +1,15 @@
 module EndpointFlux
   class Request
-    def initialize(headers: {}, params: {}, namespace: nil)
+    def initialize(headers: {}, remote_ip: '', params: {}, namespace: nil)
       @headers = headers
+      @remote_ip = remote_ip
       @params = params
       @namespace = namespace
     end
 
     attr_accessor :params
     attr_accessor :headers
+    attr_accessor :remote_ip
     attr_accessor :namespace
     attr_accessor :endpoint
     attr_accessor :scope

data/lib/endpoint_flux/version.rb

@@ -1,3 +1,3 @@
 module EndpointFlux
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/spec/lib/endpoint_flux/rails/concerns/endpoint_controller_spec.rb

@@ -0,0 +1,75 @@
+module ActiveSupport
+  module Concern ; end
+end
+
+require 'spec_helper'
+require 'endpoint_flux/rails/concerns/endpoint_controller'
+require 'ostruct'
+
+class RemoteIpDummyClass
+  include EndpointFlux::Rails::Concerns::EndpointController
+
+  def headers
+    {}
+  end
+
+  def request
+    OpenStruct.new(
+      headers: { 'authorization' => 'authorization header' },
+      remote_ip: '172.18.0.1',
+      env: { 'HTTP_X_FORWARDED_FOR' => '172.18.0.2' }
+    )
+  end
+end
+
+class LocalIpDummyClass
+  include EndpointFlux::Rails::Concerns::EndpointController
+
+  def headers
+    {}
+  end
+
+  def request
+    OpenStruct.new(
+      headers: { 'authorization' => 'authorization header' },
+      remote_ip: '127.0.0.1',
+      env: { 'HTTP_X_FORWARDED_FOR' => '172.18.0.2' }
+    )
+  end
+end
+
+RSpec.describe EndpointFlux::Rails::Concerns::EndpointController do
+  describe '#request_object' do
+    before do
+      allow(subject).to receive(:endpoint_params).and_return({})
+    end
+
+    context 'remote ip' do
+      subject { RemoteIpDummyClass.new }
+
+      it 'sets property as remote_ip' do
+        expect(
+          ::EndpointFlux::Request
+        ).to receive(:new).with(headers: { 'Authorization' => 'authorization header' },
+                                params: subject.endpoint_params,
+                                remote_ip: subject.request.remote_ip)
+
+        subject.request_object
+      end
+    end
+
+    context 'local ip' do
+      subject { LocalIpDummyClass.new }
+
+      it 'sets property as HTTP_X_FORWARDED_FOR' do
+        expect(
+          ::EndpointFlux::Request
+        ).to receive(:new).with(headers: { 'Authorization' => 'authorization header' },
+                                params: subject.endpoint_params,
+                                remote_ip: subject.request.env['HTTP_X_FORWARDED_FOR'])
+
+        subject.request_object
+      end
+    end
+  end
+end

data/spec/lib/endpoint_flux/request_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe EndpointFlux::Request do
+  it { should respond_to :headers }
+  it { should respond_to :remote_ip }
+  it { should respond_to :params }
+  it { should respond_to :namespace }
+  it { should respond_to :endpoint }
+  it { should respond_to :scope }
+
+  describe '#initialize' do
+    context 'when all params specified' do
+      let(:params) { { param: :val } }
+      let(:headers) { { header: :val } }
+      let(:remote_ip) { '127.0.0.1' }
+      let(:namespace) { 'namespace' }
+
+      it 'should set args' do
+        request = EndpointFlux::Request.new(
+          params: params,
+          headers: headers,
+          remote_ip: remote_ip,
+          namespace: namespace
+        )
+
+        expect(request.params).to eq params
+        expect(request.headers).to eq headers
+        expect(request.remote_ip).to eq remote_ip
+        expect(request.namespace).to eq namespace
+      end
+
+      context 'when params missed' do
+        it 'should set default values' do
+          request = EndpointFlux::Request.new
+
+          expect(request.params).to be_empty
+          expect(request.headers).to be_empty
+          expect(request.remote_ip).to eq ''
+          expect(request.namespace).to be_nil
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: endpoint-flux
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
-- Arturs Kreipans
+- Arturs Kreipans https://github.com/fragallia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: byebug~> 9.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec~> 3.5
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,6 +87,8 @@ files:
 - spec/lib/endpoint/middlewares_spec.rb
 - spec/lib/endpoint/perform_spec.rb
 - spec/lib/endpoint/rescue_from_spec.rb
+- spec/lib/endpoint_flux/rails/concerns/endpoint_controller_spec.rb
+- spec/lib/endpoint_flux/request_spec.rb
 - spec/lib/exceptions/forbidden_spec.rb
 - spec/lib/exceptions/not_found_spec.rb
 - spec/lib/exceptions/service_unavailable_spec.rb
@@ -111,9 +113,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -137,6 +139,8 @@ test_files:
 - spec/lib/endpoint/middlewares_spec.rb
 - spec/lib/endpoint/perform_spec.rb
 - spec/lib/endpoint/rescue_from_spec.rb
+- spec/lib/endpoint_flux/rails/concerns/endpoint_controller_spec.rb
+- spec/lib/endpoint_flux/request_spec.rb
 - spec/lib/exceptions/forbidden_spec.rb
 - spec/lib/exceptions/not_found_spec.rb
 - spec/lib/exceptions/service_unavailable_spec.rb