simple_http_service 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcdc528d7a1fd55e7bf234d0c7c656c10a3c8fc26b8ecf0ad8ba311f0fcdb66f
-  data.tar.gz: 12fde94dbe6c1739fc8bd8761d8cdf0e11657cbe7d59c2160716d2824bf4ebb0
+  metadata.gz: 48c5a5d1d5a310878535fe40f8760e7e880268aa8b5903c69e6ee8d3514d3f29
+  data.tar.gz: b46618612ffda2302a65c4e1c4a7aa7448d894f2add044ef853e221cd7a029eb
 SHA512:
-  metadata.gz: 9d3298c0b9667d62642c579bb36e03fa5754e678b29848cddd26f4a11733a69229ebddda355a14c703a7ad3cc744f1f75b2df1fc965bf737bfe91b7dcab7cfd9
-  data.tar.gz: bab3877ff4b7d731716d2630893ced996ec986695978ce24dd62bb8351d2b88af6d43c288a1a8ff819cd532d6faea82c42621bf10620dad48046d4d3b8f74680
+  metadata.gz: 568fd0858274de7ed76426e3d6d64834c1269d2456e1a37a7a89b110515676e2b84489aebf521e09ecee66f85beaa3718076fb288db0e695c2ea18b16eb09dee
+  data.tar.gz: ecf2e3fe4c140e06439ac1af14f968c9f31df7d95a4304ad89dae9de910e72fe3e2081d856541c1c22c8f10135065b9175f012f5642bb5f1d6e883d6dabd1385

data/Gemfile.lock

@@ -1,39 +1,39 @@
 PATH
   remote: .
   specs:
-    simple_http_service (0.1.0)
-      net-http (~> 0.3.2)
+    simple_http_service (0.1.2)
+      net-http (~> 0.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.5.0)
-    net-http (0.3.2)
+    diff-lcs (1.5.1)
+    net-http (0.4.1)
       uri
     rake (10.5.0)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     uri (0.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.5.10)
   rake (~> 10.0)
   rspec (~> 3.0)
   simple_http_service!
 
 BUNDLED WITH
-   1.17.3
+   2.5.11

data/README.md

@@ -1,38 +1,122 @@
-# SimpleHttp
+# SimpleHttpService
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple_http`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+SimpleHttpService is a simple Ruby library to make HTTP requests with customizable options for headers, timeouts, and retries. It provides a convenient way to create and send HTTP requests using a clean and simple interface.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'simple_http_service'
-```
+    gem 'simple_http_service'
 
 And then execute:
 
-    $ bundle
+    bundle install
 
 Or install it yourself as:
 
-    $ gem install simple_http
+    gem install simple_http_service
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating a Client
+You can create a new HTTP client using the SimpleHttpService.new method, which initializes an instance of SimpleHttpService::Client.
 
-## Development
+```ruby
+require 'simple_http_service'
+
+client = SimpleHttpService.new(
+  url: 'https://api.example.com/endpoint',
+  http_method: :get,
+  headers: {
+    accept: 'application/json',
+    authorization: 'Bearer your_token',
+    content_type: 'application/json',
+    cookie: 'your cookie'
+  },
+  open_timeout: 5,
+  read_timeout: 10,
+  write_timeout: 5,
+  retry_count: 3
+)
+```
+### Making a Request
+After creating the client, you can call the call method to make the HTTP request:
+```ruby
+response = client.call
+puts response.body
+```
 
-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.
+### Options
+- `url` (required): The URL for the HTTP request.
+- `http_method` (required): The HTTP method to use (:get, :post, :put).
+- `headers`: A hash of headers to include in the request.
+- `open_timeout`: Timeout for opening the connection (default is false).
+- `read_timeout`: Timeout for reading the response (default is false).
+- `write_timeout`: Timeout for writing the request (default is false).
+- `retry_count`: The number of times to retry the request in case of failure.
+- `request_body`: The body of the request (used for POST and PUT requests).
 
-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).
+### Example
+Here's a complete example of using `SimpleHttpService` to make a `GET` request:
 
-## Contributing
+```ruby
+require 'simple_http_service'
+
+client = SimpleHttpService.new(
+  url: 'https://api.example.com/endpoint',
+  http_method: :get,
+  headers: {
+    accept: 'application/json',
+    authorization: 'Bearer your_token'
+  },
+  open_timeout: 5,
+  read_timeout: 10
+)
+
+response = client.call
+puts response.body
+```
+For a POST request with a request body:
+```ruby
+require 'simple_http_service'
+
+client = SimpleHttpService.new(
+  url: 'https://api.example.com/endpoint',
+  http_method: :post,
+  headers: {
+    accept: 'application/json',
+    authorization: 'Bearer your_token',
+    content_type: 'application/json'
+  },
+  request_body: { key: 'value' }.to_json,
+  open_timeout: 5,
+  read_timeout: 10,
+  write_timeout: 5
+)
+
+response = client.call
+puts response.body
+```
+
+### Error Handling
+The library defines a custom error class SimpleHttpService::Error that you can use to handle exceptions:
+```ruby
+begin
+  response = client.call
+  puts response.body
+rescue SimpleHttpService::Error => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_http. 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.
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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 install`. To release a new version, update the version number in `version.rb`.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/gklsan/simple_http_service.
 
 ## License
 
@@ -40,4 +124,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SimpleHttp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_http/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SimpleHttpService project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

data/lib/simple_http_service/client.rb

@@ -1,7 +1,8 @@
 require 'net/http'
 module SimpleHttpService
   class Client
-    attr_accessor :uri, :headers, :http_method, :query
+    attr_accessor :uri, :headers, :http_method, :open_timeout, :read_timeout, :write_timeout,
+                  :retry_count, :request_body
 
     def initialize(opts)
       raise 'URL must be present' unless opts[:url]
@@ -10,12 +11,17 @@ module SimpleHttpService
       @uri = URI(opts[:url])
       @http_method = opts[:http_method]
       @headers = opts[:headers] || {}
-      @query = opts[:query]
+      @request_body = opts[:request_body]
+      @open_timeout = opts[:open_timeout] || false
+      @read_timeout = opts[:read_timeout] || false
+      @write_timeout = opts[:write_timeout] || false
+      @retry_count = opts[:retry_count]
     end
 
     def call
       enable_ssl
       set_headers
+      set_timeout
       http.request(request)
     end
 
@@ -23,13 +29,20 @@ module SimpleHttpService
 
     def set_headers
       request["Accept"] = headers[:accept] if headers[:accept]
-      request["Authorization"] = headers[:Authorization] if headers[:Authorization]
+      request["Authorization"] = headers[:authorization] if headers[:authorization]
       request["Content-Type"] = headers[:content_type] if headers[:content_type]
       request["Cookie"] = headers[:cookie] if headers[:cookie]
     end
 
     def request
-      @request ||= (http_method == :post ? Net::HTTP::Post.new(uri) : Net::HTTP::Get.new(uri))
+      @request ||= case http_method
+                   when :post
+                     Net::HTTP::Post.new(uri)
+                   when :put
+                     Net::HTTP::Put.new(uri)
+                   else
+                     Net::HTTP::Get.new(uri)
+                   end
     end
 
     def enable_ssl
@@ -39,6 +52,16 @@ module SimpleHttpService
       http.ssl_version = :TLSv1_2
     end
 
+    def set_timeout
+      http.open_timeout = open_timeout if open_timeout
+      http.read_timeout = read_timeout if read_timeout
+      http.write_timeout = write_timeout if write_timeout
+    end
+
+    def set_request_params
+      request.body = request_body if request_body.present?
+    end
+
     def http
       @http ||= Net::HTTP.new(uri.host, uri.port)
     end

data/lib/simple_http_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleHttpService
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/simple_http_service.rb

@@ -2,6 +2,9 @@ require 'simple_http_service/version'
 require 'simple_http_service/client'
 
 module SimpleHttpService
+  def self.new(*args)
+    Client.new(*args)
+  end
+
   class Error < StandardError; end
-  # Your code goes here...
 end

data/simple_http_service.gemspec

@@ -6,9 +6,8 @@ require "simple_http_service/version"
 Gem::Specification.new do |spec|
   spec.name          = "simple_http_service"
   spec.version       = SimpleHttpService::VERSION
-  spec.authors       = ["Gokul"]
+  spec.authors       = ["Gokul (gklsan)"]
   spec.email         = ["pgokulmca@gmail.com"]
-
   spec.summary       = 'Welcome to SimpleHttpService gem'
   spec.description   = 'Welcome to SimpleHttpService gem'
   spec.homepage      = "https://github.com/gklsan/simple_http_service"
@@ -36,8 +35,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "net-http", "~> 0.3.2"
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_dependency "net-http", "~> 0.4.1"
+  spec.add_development_dependency "bundler", "~> 2.5.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_http_service
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Gokul
+- Gokul (gklsan)
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2024-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.5.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.5.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Welcome to SimpleHttpService gem