dsc-auto-http-client 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ea1faf52af90dd502fa35d87d6996b9621cded8
+  data.tar.gz: d85180c31129bfe04c689f0bb8521972091cca75
+SHA512:
+  metadata.gz: 635c5946e2b1fe8478fb57d8747a93aef5799338952b628e0cdea4aafa504dc1f6de063f218aed071a22ebd8803ef551ea0d8932bdb528d424d826305098f435
+  data.tar.gz: 960736547db660f82b5950e416af7d2a29428296fd2a829dec7b0b8942df050966f869c5771435f22dfb35df3e8c16aa95ac5bcf85c41293cfa3909df25049a3

data/lib/dsc_auto_http_client.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'json'
+require 'rest-client'
+require 'uri'
+require 'logger'
+require 'optparse'
+
+
+
+
+module Dsc
+
+  module Auto
+
+    module HttpClient
+
+
+      attr_accessor :host, :email, :password, :base_uri, :user_agent, :http, :content_type, :cookie, :token, :access_token, :data_files_path, :response, :parsed_response, :version, :log_level, :history, :auth_type
+
+      def set_http_client_attributes(_args = {})
+        @logger       = Logger.new(STDOUT)
+        @log_level    = _args[:log_level] || "INFO"
+        @logger.level = Logger.const_get(@log_level)
+
+        @host     = _args[:host]
+        @version  = _args[:version]
+        @base_uri = _args[:base_uri] || "#{@host}/api/v#{@version}"
+
+        @content_type = _args[:content_type] || :json
+
+        @user_agent = _args[:user_agent] || "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) "\
+                              "AppleWebKit/537.36 (KHTML, like Gecko) "\
+                              "Chrome/48.0.2564.103 Safari/537.36"
+
+        @token        = _args[:token]
+        @cookie       = _args[:cookie]
+        @access_token = _args[:access_token]
+
+        @user
+        @email    = _args[:email]
+        @password = _args[:password]
+        @auth_type = _args[:auth_type]
+        @history  = []
+      end
+    end
+  end
+end
+
+
+require_relative 'dsc_auto_http_client/http'
+require_relative 'dsc_auto_http_client/parse_json'

data/lib/dsc_auto_http_client/http.rb

@@ -0,0 +1,216 @@
+
+module Dsc
+
+  module Auto
+
+    module HttpClient
+
+        def parsed_data_file(_filename)
+          filename = _filename.end_with?('.json') ? _filename : "#{_filename}.json"
+          @logger.debug("File : #{@data_files_path}/#{filename}")
+          parse_json(File.read("#{@data_files_path}/#{filename}"))
+        end
+
+        def get_header
+          {
+              :content_type => @content_type,
+              :accept => '*/*',
+              :cookies => @cookie
+          }
+        end
+
+        def get_request_header
+          if @access_token
+            {
+                :content_type => @content_type,
+                :accept => '*/*',
+                :authorization => "Bearer #{@access_token}",
+                :cookies => @cookie,
+                'User-Agent' => @user_agent
+            }
+          else
+            get_header
+          end
+        end
+
+        # Takes a hash of params and builds a query string for api calls
+        # == Parameters:
+        # params::
+        # hash of params - { key_one: "ValueOne", key_two: "ValueTwo" }
+        # => 'key_one=ValueOne?key_two=ValueTwo'
+        def build_query(_params = {})
+          res = ''
+          _params.each do |key, val|
+            if val.kind_of?(Array)
+              val.each do |v|
+                res << "#{key}=#{v}&"
+              end
+            else
+              res << "#{key}=#{val}&"
+            end
+          end
+
+          res
+        end
+
+        def query_string_to_hash(_query_string)
+          Hash[CGI.parse(_query_string).map { |key, values| [key.to_sym, values[0] ||= true] }]
+        end
+
+        def response_has_body?(response_object)
+          response_object.respond_to?('body')
+        end
+
+        def response_has_code?(response_object)
+          response_object.respond_to?('code')
+        end
+
+
+        def http_request(_method, _path, _args = {})
+
+          verify_ssl  = _args[:verify_ssl] == false ? false : true
+          response = begin
+
+            request = {
+                url: _path,
+                method: _method,
+                verify_ssl: verify_ssl,
+            }
+            payload = _args[:data] || _args[:payload]
+            request[:payload] = payload
+            request[:headers] = _args[:headers] || { :content_type => :json, :accept => '*/*' }
+
+            if _args[:user]
+              request[:user] = _args[:user]
+            end
+
+            if _args[:password]
+              request[:password] = _args[:password]
+            end
+
+            @logger.debug("RestClient Request : \r\n#{request}")
+
+            RestClient::Request.execute(request)
+
+          rescue RestClient::ExceptionWithResponse => e
+            unless _args[:surpress_call_error]
+              @logger.error("Dsc::Auto::HttpClient ERROR \r\n \
+                            This may be expected if using this client to test an API\r\n\s \
+                                    Base URI : #{@base_uri}\r\n\s \
+                                    API VERSION : /api/v#{@version} \r\n\s \
+                                    METHOD : #{_method.upcase}\r\n\s \
+                                    PATH : #{_path} \r\n\s \
+                                    PARAMETERS : #{_args}\r\n\s \
+                                    HEADERS : #{request[:headers]}\r\n"
+              )
+              @logger.error(e.message)
+              @logger.error(e.backtrace[0..7].join("\n"))
+              error_code = e.response.code if response_has_code?(e.response)
+              error_body = e.response.body if response_has_body?(e.response)
+              @logger.error("ERROR API RESPONSE HEADERS - #{e.response.headers}") if e.response.headers
+              @logger.error("ERROR API RESPONSE CODE - #{error_code}") if error_code
+              @logger.error("ERROR API RESPONSE BODY - #{error_body}") if error_body
+            end
+
+            e.response
+
+          end
+
+          @history << response
+
+          response
+        end ## http_request
+
+        # A symbol declaring the http method to use must be :get, :post, :put, :delete
+        ### calls http method on base_uri
+        def call(_method, _path, _args = {})
+
+          query = nil
+          error_code = nil
+          error_body = nil
+
+          path = "#{@base_uri}#{_path}"
+          headers = _args[:headers] || get_request_header
+
+          payload = _args[:payload] || _args[:data]
+
+          ### if get and pass in data, create url params out of the data hash
+          if _method == :get && payload && payload.respond_to?(:each) && payload.length > 0
+            query = build_query( payload )
+            path << "?#{query}"
+          end
+
+          @logger.debug("DSC::Auto::RestClient.Call : #{query ? "GET, #{path}" :
+                            "#{_method.upcase}, #{path}, #{_args}"}, #{headers}\r\n")
+
+          ### default args for get , delete - no payload should be just URL and headers
+          http_request_args = [ _method, path, { headers: headers }]
+          ### add data to args if post or update
+          if _method == :post || :put
+            payload = _args[:payload] || _args[:data]
+            if payload
+              http_request_args[2][:payload] = payload.to_json
+            end
+
+          end
+
+          if _args[:user]
+            http_request_args[2][:user] = _args[:user]
+          end
+
+          if _args[:password]
+            http_request_args[2][:password] = _args[:password]
+          end
+
+          http_request_args[2][:surpress_call_error] = _args[:surpress_call_error]
+
+          response = self.send(:http_request, *http_request_args)
+
+          @response = response
+        end
+
+
+        ### HTTP Methods to be called on @base_uri
+        ### _path will be appended to @base_url
+
+        def get(_path, _args = {})
+          call(:get, _path, _args)
+        end
+
+        def post(_path, _args = {})
+          call(:post, _path, _args)
+        end
+
+        def put(_path, _args = {})
+          call(:put, _path, _args)
+        end
+
+        def delete(_path, _args = {})
+          call(:delete, _path, _args)
+        end
+
+        ### HTTP methods to be called on external hosts
+
+        def get_external(_path, _args = {})
+          http_request(:get, _path, _args)
+        end
+
+        def post_external(_path, _args = {})
+          http_request(:post, _path, _args)
+        end
+
+        def put_external(_path, _args = {})
+          http_request(:put, _path, _args)
+        end
+
+        def delete_external(_path, _args = {})
+          http_request(:delete, _path, _args)
+        end
+
+
+
+    end
+
+  end
+
+end

data/lib/dsc_auto_http_client/parse_json.rb

@@ -0,0 +1,23 @@
+module Dsc
+  module Auto
+    module HttpClient
+
+      def parse_json(_json_string, _options = {})
+        fail_msg = _options[:failure_message] || _options[:path] || "parse_json failed trying to parse #{_json_string}"
+        begin
+          JSON.parse(_json_string)
+        rescue JSON::ParserError => e
+          full_fail_msg = "ERROR \r\n #{fail_msg} \r\n \
+          .parse_json expected param to be json, \
+               instead was #{_json_string} \r\n \
+          #{e.message} \r\n #{e.backtrace[0..5].join("\r\n")}"
+          raise(JSON::ParserError, full_fail_msg, caller )
+        end
+      end # self.parse_json
+
+
+
+
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: dsc-auto-http-client
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Alex Janckila
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dollar Shave Club Automation Http Client Helper
+email: alex.janckila@dollarshaveclub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dsc_auto_http_client.rb
+- lib/dsc_auto_http_client/http.rb
+- lib/dsc_auto_http_client/parse_json.rb
+homepage: https://github.com/dollarshaveclub/dsc-auto-http-client
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Dollar Shave Club Automation Http Client Helper
+test_files: []