network-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30beca79e944d3f7f1d9a042d502593a24cd28dc
+  data.tar.gz: 43176302a9f186c38ee982e962085812c324e749
+SHA512:
+  metadata.gz: 1e92a959db3b863d6d196551a6f3497fe0db2903c643354b059009d6cbb25a7996a2531f7af2b4c2fd502286b5546f64883b29ad63b2d2f4ae659e0018cc565f
+  data.tar.gz: 0c6d55ca68c2c5cfe8a577c2d730ab0b414776930908df0b9a7982d816f6020a88c9178fcf3c84da4b011dc4cfcfa600e7e6a9d25cd2576f2ce3ef3cfb7da80a

data/.gitignore

@@ -0,0 +1,55 @@
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/ruby

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+network-client

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.2.4
+  - 2.3.1
+  - 2.4.0
+  - 2.4.1
+cache: bundler
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify dependencies in network-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    network-client (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    factory_girl (4.8.0)
+      activesupport (>= 3.0.0)
+    i18n (0.8.1)
+    json (2.1.0)
+    minitest (5.10.2)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  codeclimate-test-reporter (~> 1.0.0)
+  factory_girl (~> 4.5)
+  network-client!
+  rake (~> 10.0)
+  rspec (~> 3.6)
+  simplecov
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Abdullah Barrak (abarrak)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Network Client
+[![Gem Version](https://badge.fury.io/rb/network-client.svg)](https://rubygems.org/gems/network-client)
+[![Build Status](https://travis-ci.org/abarrak/network-client.svg?branch=master)](https://travis-ci.org/abarrak/network-client)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'network-client'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install network-client
+```
+
+## Usage
+
+
+
+## Contributing
+
+Bug reports and pull requests are very much appreciated at [Github](https://github.com/abarrak/network-client).
+
+
+## License
+[MIT](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/network-client.rb

@@ -0,0 +1,2 @@
+require_relative "network-client/core"
+require_relative "network-client/version"

data/lib/network-client/core.rb

@@ -0,0 +1,128 @@
+require 'net/http'
+require 'json'
+require 'securerandom'
+require 'erb'
+require 'logger'
+
+
+module NetworkClient
+  # This class is simple HTTP client that meant to be initialized configured with a single URI.
+  # Subsequent calls should target endpoints/paths of that URI.
+  #
+  # Return values of its rest-like methods is Struct holding two values for the code and response
+  # body parsed as JSON.
+  #
+  class Client
+
+    HTTP_VERBS = {
+      :get    => Net::HTTP::Get,
+      :post   => Net::HTTP::Post,
+      :put    => Net::HTTP::Put,
+      :delete => Net::HTTP::Delete
+    }
+
+    def initialize(endpoint:, tries: 1)
+      @uri = URI.parse(endpoint)
+      @tries = tries
+      set_http_client
+      set_logger
+      set_response_struct
+    end
+
+    def get(path, params = {})
+      request_json :get, path, params
+    end
+
+    def post(path, params = {})
+      request_json :post, path, params
+    end
+
+    def put(path, params = {})
+      request_json :put, path, params
+    end
+
+    def delete(path, params = {})
+      request_json :delete, path, params
+    end
+
+    private
+
+    def set_http_client
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = true
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    def set_logger
+      @logger ||= begin
+        if block_given?
+          yield
+        else
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::DEBUG
+          logger
+        end
+      end
+    end
+
+    def set_response_struct
+      @response_struct = Struct.new(:code, :body)
+    end
+
+    def request_json(http_method, path, params)
+      response = request(http_method, path, params)
+      body = JSON.parse(response.body)
+
+      @response_struct.new(:code => response.code, :body => body)
+
+    rescue JSON::ParserError => error
+      @logger.error "parsing response body as json failed.\n Details: \n #{error.message}"
+      response
+    end
+
+    def request(http_method, path, params = {})
+      case http_method
+      when :get
+        full_path = encode_path_params(path, params)
+        request = HTTP_VERBS[http_method].new(full_path)
+      else
+        request = HTTP_VERBS[http_method].new(path)
+        request.set_form_data(params)
+      end
+
+      response = http_request(request)
+      case code = response.code
+      when Net::HTTPSuccess
+        true
+      else
+        @logger.error "example endpoint responded with a non-success #{code} code."
+      end
+
+      response
+    end
+
+    def http_request(request)
+      begin
+        tries_count ||= @tries
+        response = @http.request(request)
+      rescue Errno::ECONNREFUSED, Net::ReadTimeout, Net::OpenTimeout => error
+        @logger.warn(error)
+        retry unless (tries_count -= 1).zero?
+      else
+        response
+      end
+    end
+
+    def errors_to_recover_by_retry
+    end
+
+    def errors_to_recover_by_propogate
+    end
+
+    def encode_path_params(path, params)
+      return path if params.empty?
+      encoded = URI.encode_www_form(params)
+      [path, encoded].join("?")
+    end
+  end
+end

data/lib/network-client/version.rb

@@ -0,0 +1,3 @@
+module NetworkClient
+  VERSION = "1.0.0"
+end

data/network-client.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'network-client/version'
+require 'date'
+
+Gem::Specification.new do |spec|
+  spec.name          = "network-client"
+  spec.version       = NetworkClient::VERSION
+  spec.date          = Date.today.to_s
+  spec.authors       = ["Abdullah Barrak (abarrak)"]
+  spec.email         = ["abdullah@abarrak.com"]
+
+  spec.summary       = "A thin resilient wrapper around ruby's Net::HTTP."
+  spec.description   = "network-client gem is almost a drop-in thin layer around Net::HTTP classes \
+                        with simple error handling and retry functionality implemented."
+  spec.homepage      = "https://github.com/abarrak/network-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "factory_girl", "~> 4.5"
+  spec.add_development_dependency "simplecov", '~> 0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0', '>= 1.0.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: network-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Abdullah Barrak (abarrak)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: network-client gem is almost a drop-in thin layer around Net::HTTP classes                         with
+  simple error handling and retry functionality implemented.
+email:
+- abdullah@abarrak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/network-client.rb
+- lib/network-client/core.rb
+- lib/network-client/version.rb
+- network-client.gemspec
+homepage: https://github.com/abarrak/network-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.11
+signing_key: 
+specification_version: 4
+summary: A thin resilient wrapper around ruby's Net::HTTP.
+test_files: []