perimeter_x 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8821c69fed2516694f5cfc66c4fd86cb8350e1c6
-  data.tar.gz: cb26bfa40459f6e0745c9d1d1bdb94a07ade258b
+  metadata.gz: 52e3418c30763e225706ca5ee7a3a88958c4a210
+  data.tar.gz: 4671a1eb52edc4cfdb9ba4e85932c2dcb7e33dbb
 SHA512:
-  metadata.gz: 79d0af263099a0b1cc363546e26a2c7c3c42b80e71a7eb1b39c9f07a784ad5ad925598aa42be2036cc79620528762398c4ac58d1ee448ca792b55aa422bf2784
-  data.tar.gz: a13e5dab8ce2a5a9380996921799a5e90bb3b141f10b08b13821b07ff36efaa6cb12c1b853f7071e7ebcc3d2ffa84e21233d8442f07a01aa3607a80f287edf77
+  metadata.gz: 13ca73c6ac3c22ff0d9d93d42cab42049a06e458f9596538cd2225a07dd1ea9e20db8bf4c6921519ed29c349e717eb929643051ef1510337b1414bf6ea8f6c01
+  data.tar.gz: 2bc1a8fe0845f3899537bb34151c545ea7c6a5343b271c7bceb4d221a9551d74dec174042e30b02e7e29d533d7e0453235163ee0635d2275576c75ed4758efd5

data/Dockerfile

@@ -1,50 +1,21 @@
 # Based on manual compile instructions at http://wiki.nginx.org/HttpLuaModule#Installation
-FROM ubuntu:14.04
-RUN apt-get update && apt-get --force-yes -qq -y install \
-    build-essential \
-    ca-certificates \
-    curl \
-    git \
-    libpcre3 \
-    libpcre3-dev \
-    libssl-dev \
-    libreadline-dev \
-    libyaml-dev \
-    libgdbm-dev \
-    libtool \
-    automake \
-    bison \
-    lua-cjson \
-    libncurses5-dev \
-    m4 \
-    libsqlite3-dev \
-    rsyslog \
-    sqlite3 \
-    libxml2-dev \
-    libxslt1-dev \
-    libcurl4-openssl-dev \
-    python-software-properties \
-    libffi-dev \
-    nodejs \
-    wget \
-    zlib1g-dev
+FROM ruby:2.3.0
 
-RUN gpg --keyserver hkp://keys.gnupg.net --recv-keys D39DC0E3
-RUN /bin/bash -l -c "curl -L get.rvm.io | bash -s stable --rails"
-RUN /bin/bash -l -c "rvm install 2.3.0"
-RUN /bin/bash -l -c "rvm use 2.3.0"
-RUN /bin/bash -l -c "gem install bundler"
-RUN /bin/bash -l -c "gem install rails -v 4.2.0"
+RUN apt-get update && apt-get --force-yes -qq -y install \
+ nodejs
+ENV RAILS_VERSION 4.2.0
+RUN gem install rails --version "$RAILS_VERSION"
+RUN gem install bundler
 RUN mkdir -p /tmp/ruby_sandbox
 WORKDIR /tmp/ruby_sandbox
 RUN git clone https://github.com/PerimeterX/perimeterx-ruby-sdk.git
-RUN /bin/bash -l -c "rails new webapp"
+RUN rails new webapp
 WORKDIR /tmp/ruby_sandbox/webapp
-RUN /bin/bash -l -c "rails generate controller home index"
+
+RUN rails generate controller home index
 WORKDIR /tmp/ruby_sandbox/webapp
 EXPOSE 3000
-# TODO: make it take the files from git
 RUN sed -i '2i gem "perimeter_x", :path => "/tmp/ruby_sandbox/perimeterx-ruby-sdk"' /tmp/ruby_sandbox/webapp/Gemfile
-RUN /bin/bash -l -c "bundler update"
+RUN bundler update
 COPY ./examples/ /tmp/ruby_sandbox/webapp
-CMD ["/bin/bash", "-l", "-c", "rails server -b 0.0.0.0;"]
+CMD ["rails","server","-b","0.0.0.0"]

data/changelog.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.2.0] - 2017-06-04
+### Fixed 
+    - Default timeouts for post api requests
+    - Fixed Dockerfile
+### Changed
+    - Removed httpclient and instead using typheous
+### Added
+    - Using concurrent-ruby for async post requests
+    
 ## [1.1.0] - 2017-06-04
 ### Added 
     - Added support for sensitive routes

data/lib/perimeterx/configuration.rb

@@ -17,9 +17,9 @@ module PxModule
       :encryption_enabled       => true,
       :blocking_score           => 70,
       :sensitive_headers        => ["http-cookie", "http-cookies"],
-      :api_connect_timeout      => 0,
-      :api_timeout              => 0,
-      :max_buffer_len           => 30,
+      :api_connect_timeout      => 1,
+      :api_timeout              => 1,
+      :max_buffer_len           => 10,
       :send_page_activities     => false,
       :send_block_activities    => true,
       :sdk_name                 => PxModule::SDK_NAME,

data/lib/perimeterx/internal/clients/perimeter_x_activity_client.rb

@@ -3,12 +3,10 @@ require 'perimeterx/internal/clients/perimeter_x_risk_client'
 module PxModule
   class PerimeterxActivitiesClient < PerimeterxRiskClient
 
-    attr_accessor :activities
 
     def initialize(px_config, http_client)
       super(px_config, http_client)
       @logger.debug("PerimeterxActivitiesClients[initialize]")
-      @activities = [];
     end
 
     def send_to_perimeterx(activity_type, px_ctx, details = [])
@@ -41,13 +39,10 @@ module PxModule
           "Content-Type" => "application/json"
       };
 
-      @activities.push(px_data)
-      if (@activities.size == @px_config[:max_buffer_len])
-        @logger.debug("PerimeterxActivitiesClients[send_to_perimeterx]: max buffer length reached, sending activities")
-        @http_client.async_post(PxModule::API_V1_S2S, @activities, headers)
-
-        @activities.clear
-      end
+      s = Time.now
+      @http_client.async.post(PxModule::API_V1_S2S, px_data, headers)
+      e = Time.now
+      @logger.debug("PerimeterxActivitiesClients[send_to_perimeterx]: post runtime #{(e-s)*1000}")
     end
 
     def send_block_activity(px_ctx)

data/lib/perimeterx/internal/validators/perimeter_x_captcha_validator.rb

@@ -27,7 +27,7 @@ module PxModule
           "Content-Type" => "application/json"
       };
 
-      return @http_client.post(PxModule::API_V1_CAPTCHA, request_body, headers, @px_config[:api_timeout])
+      return @http_client.post(PxModule::API_V1_CAPTCHA, request_body, headers, @px_config[:api_timeout], @px_config[:api_timeout_connection])
 
     end
 

data/lib/perimeterx/internal/validators/perimeter_x_s2s_validator.rb

@@ -67,9 +67,9 @@ module PxModule
 
       # Custom risk handler
       if (risk_mode == PxModule::ACTIVE_MODE && @px_config.key?(:custom_risk_handler))
-        response = @px_config[:custom_risk_handler].call(PxModule::API_V2_RISK, request_body, headers, @px_config[:api_timeout])
+        response = @px_config[:custom_risk_handler].call(PxModule::API_V2_RISK, request_body, headers, @px_config[:api_timeout], @px_config[:api_timeout_connection])
       else
-        response = @http_client.post(PxModule::API_V2_RISK , request_body, headers)
+        response = @http_client.post(PxModule::API_V2_RISK , request_body, headers, @px_config[:api_timeout], @px_config[:api_timeout_connection])
       end
       return response
     end
@@ -83,9 +83,9 @@ module PxModule
       px_ctx.context[:made_s2s_risk_api_call] = true
 
       # From here response should be valid, if success or error
-      response_body = eval(response.content);
+      response_body = eval(response.body);
       # When success
-      if (response.status == 200 && response_body.key?(:score) && response_body.key?(:action))
+      if (response.code == 200 && response_body.key?(:score) && response_body.key?(:action))
         @logger.debug("PerimeterxS2SValidator[verify]: response ok")
         score = response_body[:score]
         px_ctx.context[:score] = score
@@ -100,7 +100,7 @@ module PxModule
       end #end success response
 
       # When error
-      if(response.status != 200)
+      if(response.code != 200)
         @logger.warn("PerimeterxS2SValidator[verify]: bad response, return code #{response.code}")
         px_ctx.context[:uuid] = ""
         px_ctx.context[:s2s_error_msg] = response_body[:message]

data/lib/perimeterx/utils/px_http_client.rb

@@ -1,53 +1,47 @@
-require "perimeterx/utils/px_logger"
-require "httpclient"
+require 'perimeterx/utils/px_logger'
+require 'typhoeus'
+require 'concurrent'
 
 module PxModule
   class PxHttpClient
+    include Concurrent::Async
+
     attr_accessor :px_config
-    attr_accessor :BASE_URL
-    attr_accessor :http_client
+    attr_accessor :px_client
 
     def initialize(px_config)
       @px_config = px_config
-      @http_client = HTTPClient.new(:base_url => px_config[:perimeterx_server_host])
       @logger = px_config[:logger]
       @logger.debug("PxHttpClient[initialize]: HTTP client is being initilized with base_uri: #{px_config[:perimeterx_server_host]}")
     end
 
-    def post(path, body, headers, api_timeout = 0, timeoute = 0)
-      s = Time.now
-      begin
-        @logger.debug("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
-        response = @http_client.post(path,
-                    :header => headers,
-                    :body => body.to_json(),
-                    :timeout => api_timeout
-                  )
-      rescue Net::OpenTimeout, Net::ReadTimeout => error
-        @logger.warn("PerimeterxS2SValidator[verify]: request timedout")
-        return false
-      end
-      e = Time.now
-      @logger.debug("PxHttpClient[post]: runtime: #{e-s}")
-      return response
-    end
+    # Runs a POST commant to Perimeter X servers
+    # Params:
+    # +path+:: string containing uri
+    # +body+:: hash object, containing the request body, must be converted to json format
+    # +headers+:: hash object, hold headers
+    # +api_timeout+:: int, sets the timeout for a request
+    # +connection_timeout+:: int, sets the timeout for opening a connection
 
-    def async_post(path, body, headers, api_timeout = 0, timeoute = 0)
-      @logger.debug("PxHttpClient[async_post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
+    def post(path, body, headers, api_timeout = 1, connection_timeout = 1)
       s = Time.now
       begin
         @logger.debug("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
-        response = @http_client.post_async(path,
-                    :header => headers,
-                    :body => body.to_json(),
-                    :timeout => api_timeout
-                  )
-      rescue Net::OpenTimeout, Net::ReadTimeout => error
-        @logger.warn("PerimeterxS2SValidator[verify]: request timedout")
-        return false
+        response = Typhoeus.post(
+            "#{px_config[:perimeterx_server_host]}#{path}",
+            headers: headers,
+            body: body.to_json,
+            timeout: api_timeout,
+            connecttimeout: connection_timeout
+        )
+        if response.timed_out?
+          @logger.warn('PerimeterxS2SValidator[verify]: request timed out')
+          return false
+        end
+      ensure
+        e = Time.now
+        @logger.debug("PxHttpClient[post]: runtime: #{(e-s) * 1000.0}")
       end
-      e = Time.now
-      @logger.debug("PxHttpClient[post]: runtime: #{e-s}")
       return response
     end
 

data/lib/perimeterx/version.rb

@@ -1,3 +1,3 @@
 module PxModule
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/perimeter_x.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.3'
 
-  gem.add_dependency('httpclient', '2.8.2.4')
+  gem.add_dependency('concurrent-ruby', '~> 1.0', '>= 1.0.5')
+  gem.add_dependency('typhoeus', '~> 1.1', '>= 1.1.2')
   gem.add_dependency('mustache', '~> 1.0', '>= 1.0.3')
   gem.add_dependency('activesupport', '>= 4.2.0')
 

data/readme.md

@@ -31,7 +31,8 @@ Table of Contents
 
 - Ruby version 2.3+
 - Rails version 4.2
-- [httpclient](https://rubygems.org/gems/httpclient/versions/2.8.3)
+- [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby)
+- [typhoeus](https://github.com/typhoeus/typhoeus)
 - [mustache](https://rubygems.org/gems/mustache)
 
 <a name="installation"></a> Installation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perimeter_x
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nitzan Goldfeder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +39,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.2.4
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.2.4
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement