safettp 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aacb6665f1ef7a0e355843bc2accae2d4994e4c
-  data.tar.gz: d74f7dfbac3ca4feca94d6ff59848888b12676f2
+  metadata.gz: 6618b2cd29258b2e91b22b243155349ba66dea7c
+  data.tar.gz: e817b38e0b1f6b85e8667aa6b2778757ecbb9737
 SHA512:
-  metadata.gz: 3bd9caea86427d62a6ec42cdcb821ab01f835a2a42f85b29a316e587aa64b8e5a307d8b56976b4d32dea6a457bfb7a2bac894ed4f97561940fce7886fc81c8f1
-  data.tar.gz: 15644c03034daa143f7864e2c7c63a4921a1abc6f42ac8795a99c2641f0b927badb1ba966eb1e394873f977e29640580a522c41174dc6a8b4b0621268e1ee8bc
+  metadata.gz: 0d3a7143f74745f395407e47f86a5898cb842829334b2e28abb5a713fd73a3bd9786a58f85b173fb29bf9b18ecf0421aa9c090736cc02fe1c6cbc47a41254845
+  data.tar.gz: 817c3da02a82539ff7770efeb2683e13449de834019ec1845893b36992959496fd5b3d2a10b5ea1e4c3cda2eb25e097c8b291950bbb7c6d6d14a8f043e339c53

data/README.md

@@ -1,10 +1,10 @@
 # Safettp
+Make sure HTTP requests never fail.
 
-Safettp is another HTTP library. It encourages your requests to always handle
-the failure state, and does so in a straightforward and easy way.
+## Synopsis
+Safettp is an easy configurable HTTP library that encourages you to always cover what will happen after a request has been made.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -19,22 +19,33 @@ Or install it yourself as:
 
     $ gem install safettp
 
-## Synopsis
+## Usage
+
+### A simple example for the cool kids.
 ```ruby
-class MyHttpClient
+class HTTPBinClient
   include Safettp::Client
 
+  # Setup the default setting for any given request.
   configure do |config|
+    # The base url every request url will be appended to.
     config.base_url = 'https://httpbin.org'
+
+    # Additional options that specify the nature of the default request.
+    # Find all options available (here)[#options]
     config.default_options = { headers: { Accept: 'application/json' } }
   end
 
-  def do_post(payload, &block)
-    post('/post', payload, &block)
+  # Define a custom client method. This method will be available both on a new
+  # client instance and on the class itself.
+  def test_post(payload, &block)
+    post('/post', body: payload, &block)
   end
 end
 
-MyHttpClient.do_post({ body: 'my_body' }) do |result|
+# Perform a request. The result object must be given a block for both the
+# success state and failure state.
+MyHttpClient.do_post(message: 'Hello world!') do |result|
   result.on_success do |response|
     puts response.parsed_body
   end
@@ -44,9 +55,88 @@ MyHttpClient.do_post({ body: 'my_body' }) do |result|
   end
 end
 ```
+### The client
+To make use of the available functionality in Safettp, you will have to include the `Safettp::Client` module on a class of yours.
+```ruby
+class HTTPBinClient
+  include Safettp::Client
+end
+```
 
-## Development
+Most often your HTTP client will be using the same set of options for every request. You can configure them like so:
+```ruby
+class HTTPBinClient
+  include Safettp::Client
 
+  configure do |config|
+    config.base_url = 'https://httpbin.org'
+    config.default_options = { headers: { Accept: 'application/json' } }
+  end
+end
+```
+
+From this point on your client is fit for fight!
+
+### Performing a request
+ A client will be able to perform the 4 common HTTP methods like so:
+```ruby
+# You can replace `post` with your prefered method
+HTTPBinClient.post('https://httpbin.org/post', options) do |result|
+  result.on_success do |response|
+    # Your code goes here upon success.
+  end
+
+  result.on_failure do |response|
+    # Your code goes here upon failure.
+  end
+end
+```
+
+As you can see two separate blocks are yielded whether the request succeeded or failed. In order to use the method you will have to provide both. This will guard you from unexpected errors, neat right?
+
+The options hash provided as the second parameter in the example above can be used to append additional information to the request. _You can read about the available options [here](###\ Request\ options)_
+
+### The response object
+To retrieve the data obtained from the request you call `#parsed_body`. It will parse the data from JSON.
+```ruby
+result.on_success do |response|
+  puts response.parsed_body
+end
+```
+
+In case of a failed request, you can find additional information by calling `#http_response`. This will return a `Net::HTTPResponse` object which you can investigate further.
+
+### Request options
+#### Request body
+A body can be set with the `:body` option. It will be parsed to JSON.
+```ruby
+HTTPBinClient.post('/post', body: { foo: 'bar' })
+# ...
+```
+
+#### Query parameters
+Query parameters can be set with the `:query` option.
+```ruby
+HTTPBinClient.get('/get', query: { foo: 'bar' })
+```
+
+#### Headers
+Headers can be set with the `:headers` option.
+```ruby
+HTTPBinClient.get('/get', headers: { Accept: 'application/json' })
+```
+
+#### Authentication
+Authentication can be set with the `:auth` option. As of now Safettp only supports basic authentication.
+```ruby
+HTTPBinClient.get('/get', auth: {
+  type: :basic,
+  username: 'username',
+  password: 'password'
+})
+```
+
+## 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).

data/lib/safettp/client.rb

@@ -21,7 +21,11 @@ module Safettp::Client
   end
 
   module ClassMethods
-    attr_accessor :config
+    attr_writer :config
+
+    def config
+      @config || Safettp::Client::Configuration.new
+    end
 
     def instance_from_default_options
       new(config.base_url, config.default_options)
@@ -37,8 +41,7 @@ module Safettp::Client
     end
 
     def configure
-      self.config ||= Safettp::Client::Configuration.new
-      yield(config)
+      yield(@config)
     end
   end
 

data/lib/safettp/version.rb

@@ -1,3 +1,3 @@
 module Safettp
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/safettp.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Safettp::VERSION
   spec.authors       = ["Emric"]
   spec.email         = ["emric.mansson@gmail.com"]
-
+  spec.homepage      = "https://github.com/istanful/safettp"
   spec.summary       = %q{Simple HTTP library with guarded requests.}
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safettp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Emric
@@ -97,7 +97,7 @@ files:
 - lib/safettp/response.rb
 - lib/safettp/version.rb
 - safettp.gemspec
-homepage: 
+homepage: https://github.com/istanful/safettp
 licenses:
 - MIT
 metadata: