shc 0.0.1

data/README.md

@@ -0,0 +1,55 @@
+# Simple http(s) client
+
+A simple HTTP(S) client in Ruby to query any RESTful API.
+
+---
+
+Will be Implemented Request methods :
+
+  * GET
+  * POST
+  * PUT
+  * DELETE
+
+Need to be implemented :
+
+  * HEAD
+  * TRACE
+  * OPTIONS
+  * CONNECT
+  * PATCH
+
+---
+
+### Request methods cheat-sheet
+
+| HTTP Method | RFC                                         | Request has Body | Response has body | Safe | Idempotent | Cacheable |
+| ----------- | ------------------------------------------- | ---------------- | ----------------- | ---- | ---------- | --------- |
+| GET         | [7231](https://tools.ietf.org/html/rfc7231) | No               | Yes               | Yes  | Yes        | Yes       |
+| HEAD        | [7231](https://tools.ietf.org/html/rfc7231) | No               | No                | Yes  | Yes        | Yes       |
+| POST        | [7231](https://tools.ietf.org/html/rfc7231) | Yes              | Yes               | No   | No         | Yes       |
+| PUT         | [7231](https://tools.ietf.org/html/rfc7231) | Yes              | Yes               | No   | Yes        | No        |
+| DELETE      | [7231](https://tools.ietf.org/html/rfc7231) | No               | Yes               | No   | Yes        | No        |
+| PATCH       | [5789](https://tools.ietf.org/html/rfc5789) | Yes              | Yes               | No   | No         | Yes       |
+| CONNECT     | [7231](https://tools.ietf.org/html/rfc7231) | Yes              | Yes               | No   | No         | No        |
+| TRACE       | [7231](https://tools.ietf.org/html/rfc7231) | No               | Yes               | Yes  | Yes        | No        |
+| OPTIONS     | [7231](https://tools.ietf.org/html/rfc7231) | Optional         | Yes               | Yes  | Yes        | No        |
+
+
+### Some "Request Methods" explanations
+
+#### HEAD
+
+> The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content
+
+#### TRACE
+
+> The TRACE method echoes the received request so that a client can see what (if any) changes or additions have been made by intermediate servers.
+
+#### OPTIONS
+
+> The OPTIONS method returns the HTTP methods that the server supports for the specified URL. This can be used to check the functionality of a web server by requesting '*' instead of a specific resource.
+
+#### CONNECT
+
+> The CONNECT method converts the request connection to a transparent TCP/IP tunnel, usually to facilitate SSL-encrypted communication (HTTPS) through an unencrypted HTTP proxy.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/shc.rb

@@ -0,0 +1,5 @@
+###
+# SHC Namespace
+#
+module SHC
+end

data/lib/shc/client.rb

@@ -0,0 +1,26 @@
+module SHC
+  ##
+  # Client class
+  #
+  class Client
+    attr_reader :host, :request_headers, :url
+
+    ##
+    # Create a new client
+    #
+    # @param host[String] base url of the API
+    # @param request_headers[Hash] the headers of the query
+    # @param url[Array<String>] the API url segments
+    # @param version[String] the API version
+    #
+    def initialize(host: nil, request_headers: nil, url: nil, version: nil)
+      @host = host
+      @request_headers = request_headers || {}
+      @url = url || []
+      @version = version
+      @methods = %w[delete get patch post put]
+      @query_params = nil
+      @request_body = nil
+    end
+  end
+end

data/lib/shc/errors.rb

@@ -0,0 +1,8 @@
+module SHC
+  class Error < StandardError; end
+
+  class ServerError < Error; end
+  class NotFound < Error; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+end

data/lib/shc/response.rb

@@ -0,0 +1,25 @@
+require 'multi_json'
+
+module SHC
+  ##
+  # Response class
+  #
+  class Response
+    attr_reader :headers, :status_code, :body
+
+    ##
+    # Create a new response
+    #
+    # @param response[Net::HTTPResponse] The response
+    #
+    def initialize(response)
+      @status_code = response.code
+      @headers = response.to_hash
+      @body = MultiJson.decode response.body
+    end
+
+    def error?
+      @body.has_key('error')
+    end
+  end
+end

data/lib/shc/version.rb

@@ -0,0 +1,3 @@
+module SHC
+  VERSION = '0.0.1'.freeze
+end

data/shc.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shc"
+  spec.version       = SHC::VERSION
+  spec.authors       = ["Stéphane FEUGA"]
+  spec.email         = ["sfeuga@member.fsf.org"]
+  spec.summary       = %q{Simple HTTP and HTTPS Client in Ruby}
+  spec.description   = %q{A simple HTTP and HTTPS client in Ruby to query any RESTful API}
+  spec.homepage      = "https://github.com/sfeuga/simple-http_s-client"
+  spec.required_ruby_version = '>= 2.3'
+  spec.license       = "GPL-3.0-or-later"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rubocop', '~> 0.68'
+  spec.add_development_dependency 'travis', '~> 1.8'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: shc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stéphane FEUGA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A simple HTTP and HTTPS client in Ruby to query any RESTful API
+email:
+- sfeuga@member.fsf.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/shc.rb
+- lib/shc/client.rb
+- lib/shc/connection.rb
+- lib/shc/errors.rb
+- lib/shc/headers.rb
+- lib/shc/request.rb
+- lib/shc/response.rb
+- lib/shc/version.rb
+- shc.gemspec
+homepage: https://github.com/sfeuga/simple-http_s-client
+licenses:
+- GPL-3.0-or-later
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Simple HTTP and HTTPS Client in Ruby
+test_files: []