motion-http 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e08d0e8132c9c56a98c4c06ab626ae647ea17818edb12bcfb0fc3d07f6b091
-  data.tar.gz: ea9eb01732c98423f6e109fe51b3cb925f63d620cbbd9a13304f955a116ccf84
+  metadata.gz: 9a2a08f70352d4ca6c4a4b3a79ab5825e806787ab90088bcad88350360d5c11f
+  data.tar.gz: 9bfc38b0f0138c7c4fb5ab98974ddb4ab852ed96e083d001ec683463d2e5f0ce
 SHA512:
-  metadata.gz: ac6c4d219bba2251d9361465a4f755d483ee2625d399e92c7e9809c3f269905184d764bdda3b26d0d949161763e84c30b15a45d8bed0295e36d50dd7377b8685
-  data.tar.gz: 43b654efcb82dd09d9822c3b7a7dd328077978aa25b40c247f69d48b1e5bfc3e9c5d419272ac9036177ee02046c6af71733a54737530491905cce7b3b6fac568
+  metadata.gz: 2a3d796b3c9654461fb66b42456e7f43bfd6d896e5d3f0165c5d00dcb184ca5867b55a089d2eb75d2508b76697bec120bc1047874bc02530cb5e0c93896aa2ec
+  data.tar.gz: caf9553c2567c658ffd23c303dba63014a30fba3f5f4f111339753a8bab2c4b8bb9dbde0aa39d0d2e4dbac689bb826e75760123b502411687c4ea93dcee8c7cf

data/README.md

@@ -8,7 +8,7 @@ Supported platforms:
 
 It makes use of the officially supported networking libraries provided by Apple and Google. The goal of this gem is to provide you with a stable alternative to using these libraries directly, using a syntax that is much easier to use.
 
-Please report any bugs and suggestions for improvement!
+Please report any bugs or suggestions for improvement!
 
 ## Installation
 
@@ -33,9 +33,9 @@ end
 
 ## Usage
 
-Using `motion-http` is quick and easy. You can use the simple approach for making one-off requests, or the advanced approach of creating a reusable API client for further customization.
+Using `motion-http` is quick and easy. You can either make one-off requests or create a reusable API client for further customization.
 
-### Simple Usage
+### Basic Usage
 
 The basic syntax for a request looks like this:
 ```ruby
@@ -89,16 +89,25 @@ HTTP.get("http://api.example.com/people.json") do |response|
 end
 ```
 
-Use the `follow_redirects` option to specify whether or not to follow redirects. It defaults to true:
+Use the `follow_redirects` option to specify whether or not to follow redirects. The default is `true`:
 ```ruby
 HTTP.get("http://example.com/redirect", follow_redirects: false) do |response|
   # ...
 end
 ```
 
-When making a `POST` request, specify the `:form` option and it will automatically be encoded as `application/x-www-form-urlencoded` request body:
+#### POST Requests
+
+When making a `POST` request, specifying the request body is easy:
+```ruby
+HTTP.post("http://www.example.com/endpoint", body: raw_request_body) do |response|
+  # ...
+end
+```
+
+Specify the `:form` option and it will automatically be encoded as `application/x-www-form-urlencoded` request body:
 ```ruby
-HTTP.post("http://www.example.com/login", form: { user: 'andrew', pass: 'secret'}) do |response|
+HTTP.post("http://www.example.com/login", form: { user: 'andrew', password: 'secret'}) do |response|
   if response.success?
     puts "Authenticated!"
   elsif response.client_error?
@@ -122,7 +131,7 @@ HTTP.post("http://www.example.com/widgets", json: { widget: { name: "Foobar" } }
 end
 ```
 
-Request specific headers can also be specified with the `:headers` option (overriding any previously set headers):
+To specify request specific headers, use the `:headers` option. This overrides any previously set headers. In this example, we override the default JSON content type:
 ```ruby
 HTTP.post("http://www.example.com/widgets",
     headers: { 'Content-Type' => 'application/vnd.api+json' },
@@ -134,12 +143,12 @@ end
 
 All other HTTP method requests work the same way:
 ```ruby
-HTTP.put(url, params) { ... }
-HTTP.patch(url, params) { ... }
-HTTP.delete(url, params) { ... }
-HTTP.head(url, params) { ... }
-HTTP.options(url, params) { ... }
-HTTP.trace(url, params) { ... }
+HTTP.put(url, options) { ... }
+HTTP.patch(url, options) { ... }
+HTTP.delete(url, options) { ... }
+HTTP.head(url, options) { ... }
+HTTP.options(url, options) { ... }
+HTTP.trace(url, options) { ... }
 ```
 
 ### Advanced Usage
@@ -192,7 +201,13 @@ client.headers['Authorization'] = "Token token=#{my_token}"
 
 ### Logging
 
-By default, requests and responses will be logged. If you would like to disable this:
+Logging is disabled by default. To enable logging:
+
+```
+HTTP.logger.enable!
+```
+
+To disable it again:
 
 ```
 HTTP.logger.disable!
@@ -222,13 +237,13 @@ Copyright (c) 2015-2016, HipByte (info@hipbyte.com) and contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met: 
+modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer. 
+   list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution. 
+   and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

data/lib/common/http/logger.rb

@@ -3,9 +3,8 @@ class Motion
     class Logger
       attr_reader :enabled
 
-      def initialize(enabled = true)
-        # TODO: add ability to configure amount of logging (i.e. request URL only, no body, etc)
-        @enabled = enabled
+      def initialize
+        @enabled = false # logging is disabled by default
       end
 
       def enable!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-http
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrew Havens
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: motion-lager
@@ -53,7 +53,7 @@ homepage: https://github.com/rubymotion-community/motion-http
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A cross-platform HTTP client for RubyMotion that's quick and easy to use.
 test_files: []