http_connect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0804c4e6d31ad1428ff8d3d6f0a546004fbb051
+  data.tar.gz: 4f4f2fd187c9a8d809a40e7d45e993d9a4f71115
+SHA512:
+  metadata.gz: d913c7ec288c7fb4a222e2fc417f374c9ed6a8c98234c5d0e3fc2e04c090ea367d5e08093ef0b8f6bdd768056aa6385ab3cd9747288de2b2a4d1d0a279f45571
+  data.tar.gz: ce3d11d88e80b2074f703dacdbca507f9618794c24240614602e238d069c2b457c374707edda283d6598ade73403c831684f19ec79903dc70636069a7771c988

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tochemey@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in http_connect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,54 @@
+# HttpConnect
+
+A minimal ruby Rest client that uses around the ruby Net::Http library to make requests. It features a simple interface for making Web requests. It has been written and tested on an environment using ruby 2.0 or later.
+
+## Features
+
+Currently the following HTTP verbs are supported
+
+* POST
+* GET
+* DELETE
+* PUT
+
+Also it handle both https and http and one can use the basic authentication mode against a web resource
+that accepts basic authentication mode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_connect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_connect
+
+## Usage
+
+Some unit tests have been provided as examples. These unit tests are done against the 
+[Hubtel Integration Platform APIs](https://developers.hubtel.com/).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/http_connect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HttpConnect project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/http_connect/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "http_connect"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/http_connect.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http_connect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'http_connect'
+  spec.version       = HttpConnect::VERSION
+  spec.authors       = ['Arsene Tochemey GANDOTE']
+  spec.email         = ['tochemey@gmail.com']
+
+  spec.summary       = 'Basic Http Client.'
+  spec.description   = 'Wrapper around the ruby Net::Http library'
+  spec.homepage      = 'https://github.com/Tochemey/HttpConnect'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #  raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #    'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+end

data/lib/http_connect.rb

@@ -0,0 +1,187 @@
+require 'http_connect/version'
+require 'Base64'
+require 'http_connect/http_post'
+require 'http_connect/http_get'
+require 'http_connect/http_put'
+require 'http_connect/http_request'
+require 'http_connect/http_response'
+require 'http_connect/http_delete'
+require 'net/http'
+require 'pry'
+require 'json'
+
+# HttpConnect module
+module HttpConnect
+  # constants definition
+  DEFAULT_ACCEPT = 'application/json'.freeze
+  DEFAULT_CONTENT_TYPE = 'application/json'.freeze
+  FORM_DATA = 'application/x-www-form-urlencoded'.freeze
+
+  #  BasicRestClient
+  class BasicRestClient
+    attr_reader :base_url # base url of the http request
+    attr_accessor :custom_headers # custom http headers to add to the request
+    attr_accessor :read_write_timeout # read and write http request timeout
+    attr_accessor :connection_timeout # connection timeout
+    attr_accessor :use_ssl # helps to set the request scheme to https
+
+    # initialize()
+    def initialize(base_url)
+      @base_url = base_url
+      @custom_headers = {}
+      @read_write_timeout = 8000
+      @connection_timeout = 2000
+      @use_ssl = false
+    end
+
+    # set_basic_auth()
+    # @param username the username credential
+    # @param password the password credential
+    def set_basic_auth(username, password)
+      @custom_headers['Authorization'] =
+        "Basic #{Base64.encode64(username + ':' + password)}".chomp
+    end
+
+    # execute(). It helps execute an Http request
+    # one can use the following object:
+    #     - HttpPost
+    #     - HttpGet
+    #     - HttpDelete
+    #     - HttpPut
+    # @param http_webrequest the HttpRequest object
+    # @return HttpResponse object or an Http Error object
+    def execute(http_webrequest)
+      raise ArgumentError, 'http_webrequest is not a subclass of HttpRequest' 
+          unless http_webrequest.is_a? HttpRequest
+      do_http_request(http_webrequest.path,
+                      http_webrequest.http_method,
+                      http_webrequest.content_type,
+                      http_webrequest.accept, http_webrequest.content)
+    end
+
+    # post(). It helps send an HTTP POST request
+    # to create the specified resource
+    # @param path the resource path
+    # @param content_type the http request content type
+    # @param accept the expected mime type of the response
+    # @param content the http request payload
+    def post(path, content_type, accept, content = {})
+      execute HttpConnect::HttpPost.new(path, content_type, accept, content)
+    end
+
+    # put(). It helps send an HTTP PUT request
+    # to create or modified the specified resource
+    # @param path the resource path
+    # @param content_type the http request content type
+    # @param accept the expected mime type of the response
+    # @param content the http request payload
+    def put(path, content_type, accept, content = {})
+      execute HttpConnect::HttpPut.new(path, content_type, accept, content)
+    end
+
+    # get(). It helps send an HTTP GET request
+    # to fetch the specified resource
+    # @param path the resource path
+    # @param content_type the http request content type
+    # @param accept the expected mime type of the response
+    # @param content the http request payload
+    def get(path, accept, content = {})
+      execute HttpConnect::HttpGet.new(path, nil, accept, content)
+    end
+
+    # delete(). It helps send an HTTP DELETE request
+    # to delete the specified resource
+    # @param path the resource path
+    # @param content_type the http request content type
+    # @param accept the expected mime type of the response
+    # @param content the http request payload
+    def delete(path, accept, content = {})
+      execute HttpConnect::HttpDelete.new(path, nil, accept, content)
+    end
+
+    private
+
+    # open_connection()
+    def open_connection(path)
+      URI.parse(@base_url + path)
+    end
+
+    # apply_headers().
+    # Helps apply all the custom http headers set.
+    def apply_headers(request)
+      @custom_headers.each do |key, value|
+        request.add_field key, value
+      end
+    end
+
+    # do_http_request()
+    # Helps prepare and execute http web request
+    # @param path the resource path
+    # @param http_method the http verb used to access the resource
+    # @param content_type the content type used to access the resource
+    # @param accept the accept response header
+    # @param content the request payload
+    # @return HttpResponse instance
+    def do_http_request(path, http_method, content_type, accept, content = {})
+      uri = open_connection path
+      request = extract_request(uri, http_method)
+      request.content_type = content_type unless content_type.to_s.empty?
+      request['Accept'] = accept
+      apply_headers request
+      if (%w[POST PUT].include? http_method) && !content.empty?
+        handle_content request, content_type, content
+      end
+      fire_request(uri, request)
+    end
+
+    def handle_content(request, content_type, content)
+      case content_type
+      when DEFAULT_CONTENT_TYPE then
+        request.body = content.to_json
+        request.add_field 'Content-Length', request.body.size
+      when FORM_DATA then request.set_form_data(content)
+      else request.set_form_data(content)
+      end
+    end
+
+    # fire_request()
+    # @param uri the request URI object
+    # @param request the http request object
+    # @return HttpResponse instance
+    def fire_request(uri, request)
+      response = Net::HTTP.start(uri.host,
+                                 use_ssl: @use_ssl,
+                                 read_timeout: @read_write_timeout) do |http|
+        http.request(request)
+      end
+      extract_response response
+    end
+
+    # extract_request()
+    # @param uri the request URI object
+    # @param http_method the request http method used
+    # @return the http request object
+    def extract_request(uri, http_method)
+      request = case http_method
+                when 'POST' then Net::HTTP::Post.new(uri)
+                when 'GET' then Net::HTTP::Get.new(uri)
+                when 'DELETE' then Net::HTTP::Delete.new(uri)
+                when 'PUT' then Net::HTTP::Put.new(uri)
+                else raise 'invalid http method'
+                end
+      request
+    end
+
+    # extract_response()
+    # @param response the Net::HTTPResponse object to extract
+    def extract_response(response)
+      case response
+      when Net::HTTPSuccess, Net::HTTPRedirection then
+        HttpConnect::HttpResponse.new(response.code.to_i,
+                                      response.body, response.to_hash)
+      else
+        response.value
+      end
+    end
+  end
+end

data/lib/http_connect/http_delete.rb

@@ -0,0 +1,12 @@
+require 'http_connect/http_request'
+
+module HttpConnect
+  # HttpDelete class
+  class HttpDelete < HttpRequest
+    # initialize()
+    def initialize(path, content_type = 'application/json',
+                   accept = 'application/json', content = {})
+      super(path, 'DELETE', content_type, accept, content)
+    end
+  end
+end

data/lib/http_connect/http_get.rb

@@ -0,0 +1,12 @@
+require 'http_connect/http_request'
+
+module HttpConnect
+  # HttpGet class
+  class HttpGet < HttpRequest
+    # initialize()
+    def initialize(path, content_type = 'application/json',
+                   accept = 'application/json', content = {})
+      super(path, 'GET', content_type, accept, content)
+    end
+  end
+end

data/lib/http_connect/http_post.rb

@@ -0,0 +1,12 @@
+require 'http_connect/http_request'
+
+module HttpConnect
+  # HttpPost class
+  class HttpPost < HttpRequest
+    # initialize()
+    def initialize(path, content_type = 'application/json',
+                   accept = 'application/json', content = {})
+      super(path, 'POST', content_type, accept, content)
+    end
+  end
+end

data/lib/http_connect/http_put.rb

@@ -0,0 +1,12 @@
+require 'http_connect/http_request'
+
+module HttpConnect
+  # HttpPut class
+  class HttpPut < HttpRequest
+    # initialize()
+    def initialize(path, content_type = 'application/json',
+                   accept = 'application/json', content = {})
+      super(path, 'PUT', content_type, accept, content)
+    end
+  end
+end

data/lib/http_connect/http_request.rb

@@ -0,0 +1,22 @@
+module HttpConnect
+  # HttpRequest class
+  class HttpRequest
+    attr_reader :path # resource path
+    attr_reader :http_method # http verb
+    attr_reader :accept # accept header for the response
+    attr_reader :content # payload
+    attr_reader :content_type # content type
+
+    # initialize()
+    def initialize(path, method, content_type = 'application/json',
+                   accept = 'application/json', content = {})
+      @path = path
+      @http_method = method
+      @accept = accept
+      @content = content
+      @content_type = content_type
+
+      @path += '?' + URI.encode_www_form(@content) if %w[GET DELETE].include? @http_method
+    end
+  end
+end

data/lib/http_connect/http_response.rb

@@ -0,0 +1,13 @@
+module HttpConnect
+  # HttpResponse class
+  class HttpResponse
+    attr_reader :status_code # http status code
+    attr_reader :body # http response body
+    attr_reader :headers # http response headers
+    def initialize(status_code, body, headers = {})
+      @status_code = status_code
+      @body = body
+      @headers = headers
+    end
+  end
+end

data/lib/http_connect/version.rb

@@ -0,0 +1,3 @@
+module HttpConnect
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: http_connect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arsene Tochemey GANDOTE
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: Wrapper around the ruby Net::Http library
+email:
+- tochemey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- http_connect.gemspec
+- lib/http_connect.rb
+- lib/http_connect/http_delete.rb
+- lib/http_connect/http_get.rb
+- lib/http_connect/http_post.rb
+- lib/http_connect/http_put.rb
+- lib/http_connect/http_request.rb
+- lib/http_connect/http_response.rb
+- lib/http_connect/version.rb
+homepage: https://github.com/Tochemey/HttpConnect
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Basic Http Client.
+test_files: []