pad_utils 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f20532eea9d248ad0a3a09a1f38fec0aee429e8a
-  data.tar.gz: eedd6b1ab92a02888509016854a7d1dede571f82
+  metadata.gz: 0471e41fb140abe4e37fd587b465378a0bddf68a
+  data.tar.gz: 52237b1cdf91df4ceafc3b5d63b610af815dc5c6
 SHA512:
-  metadata.gz: b1789c6831bf3fd7e3624b1edd77e1840a5e9a474fa6ab6439d6a7320ade187945a8f2b023ca0d1467be0c8e73702e503afcf3c9ce905f7f9d9cde8e0dd84fd8
-  data.tar.gz: d0c74437e400de8032969f035b9749e7e0e4e4acd40a55213b1d6219655c250e75b1d0b304d6f0bb38df3c5d33eedc4023e6d4bb47d94a70b148b76515e4aa48
+  metadata.gz: edabee76a841be4a573f42fd33be76bcffcae36e3577f8aa0da113726a318a82f425052273ddd9a12eea4496a471b87c02af3214107755f33d88f2150ab68508
+  data.tar.gz: 659c69afea1249b8d26ff77daf479b98e7095e1c7c5a155cc26e7244681f72fad591431aec0bcb439128945910a794ea8244222b61e154443d6ba9c78506c0ad

data/README.md

@@ -21,11 +21,6 @@ PadUtils is fully documented at [padutils.padstone.io](http://padutils.padstone.
 [Get in touch](https://twitter.com/nicoschuele) before submitting a pull request, I don't want to waste your time by rejecting it!
 
 
-## Testing
-
-The test suite for PadUtils is currently outside of the gem itself. I may add it if I have time.
-
-
 ## License
 
 Copyright 2016 - Nico Schuele

data/lib/pad_utils/pad_http.rb

@@ -0,0 +1,85 @@
+require 'httparty'
+require 'json'
+module PadUtils
+
+  # Sends a HTTP POST request.
+  #
+  # @note Although it can parse any JSON responses, this method is made to work
+  #   in conjunction with PadUtils on the server side code.
+  #
+  # If the server can't be reached, `{error: "Server unreachable"}` is returned.
+  #
+  # If the JSON in the response can't be parsed (or if it's not JSON),
+  #   `{error: "Response is not JSON"}` is returned.
+  #
+  # @param url [String] the url to call
+  # @param body [Hash] the hash containing the key/value pairs to send
+  # @param headers [Hash] the hash containing the header key/value pairs
+  # @return [Hash] the response as a hash
+  # @example
+  #   url = "http://example.com/api/movies"
+  #   body = {year: 2008, director: "Nolan"}
+  #   PadUtils.http_post(url: url, body: body) # => {movie: "The Dark Knight"}
+  def self.http_post(url: "", body: {}, headers: {'User-Agent' => 'Padstone'})
+    reply_hash = {}
+    body = PadUtils.hash_to_json(body)
+    reply = HTTParty.post(url, {headers: headers, body: body}).to_s
+    reply_hash = PadUtils.json_to_hash reply
+    reply_hash
+  rescue JSON::ParserError => e
+    reply_hash = {error: "Response is not JSON"}
+  rescue Errno::ECONNREFUSED => e
+    reply_hash = {error: "Server unreachable"}
+  rescue Exception => e
+    reply_hash = {error: e.message}
+  end
+
+  # Sends a HTTP GET request and receives plain text.
+  #
+  #
+  # If the server can't be reached, `"Server unreachable"` is returned.
+  #
+  # @param url [String] the url to call
+  # @param headers [Hash] the hash containing the header key/value pairs
+  # @return [String] the response
+  # @example
+  #   url = "http://example.com/api/joke"
+  #   PadUtils.http_get_plain(url) # => "There are 10 kinds of programmers."
+  def self.http_get_plain(url, headers: {'User-Agent' => 'Padstone'})
+    reply = HTTParty.get(url, headers: headers).to_s
+  rescue Errno::ECONNREFUSED => e
+    reply = "Server unreachable"
+  rescue Exception => e
+    reply = e.message
+  end
+
+  # Sends a HTTP GET request and receives a hash.
+  #
+  # @note Although it can parse any JSON responses, this method is made to work
+  #   in conjunction with PadUtils on the server side code.
+  #
+  # If the server can't be reached, `{error: "Server unreachable"}` is returned.
+  #
+  # If the JSON in the response can't be parsed (or if it's not JSON),
+  #   `{error: "Response is not JSON"}` is returned.
+  #
+  # @param url [String] the url to call
+  # @param headers [Hash] the hash containing the header key/value pairs
+  # @return [Hash] the response as a hash
+  # @example
+  #   url = "http://example.com/api/weather"
+  #   PadUtils.http_get(url) # => {Geneva: "Sunny", Lausanne: "Cloudy"}
+  def self.http_get(url, headers: {'User-Agent' => 'Padstone'})
+    reply_hash = {}
+    reply = HTTParty.get(url, headers: headers).to_s
+    reply_hash = PadUtils.json_to_hash reply
+    reply_hash
+  rescue JSON::ParserError => e
+    reply_hash = {error: "Response is not JSON"}
+  rescue Errno::ECONNREFUSED => e
+    reply_hash = {error: "Server unreachable"}
+  rescue Exception => e
+    reply_hash = {error: e.message}
+  end
+
+end

data/lib/pad_utils/version.rb

@@ -1,4 +1,4 @@
 module PadUtils
   # PadUtils version number
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

data/lib/pad_utils.rb

@@ -8,6 +8,7 @@ require_relative "pad_utils/pad_json"
 require_relative "pad_utils/pad_color"
 require_relative "pad_utils/pad_code"
 require_relative "pad_utils/pad_security"
+require_relative "pad_utils/pad_http"
 
 # Main namespace for PadUtils.
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pad_utils
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Nico Schuele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -30,9 +30,28 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 description: PadUtils is a simple gem containing common utilities and shortcuts. It
-  is used in the [Padstone](http://padstone.io) app builder but can be embedded in
-  any other Ruby project.
+  is used in the Padstone app builder but can be embedded in any other Ruby project.
 email:
 - help@padstone.io
 executables:
@@ -48,6 +67,7 @@ files:
 - lib/pad_utils/pad_code.rb
 - lib/pad_utils/pad_color.rb
 - lib/pad_utils/pad_files.rb
+- lib/pad_utils/pad_http.rb
 - lib/pad_utils/pad_json.rb
 - lib/pad_utils/pad_logger.rb
 - lib/pad_utils/pad_menu.rb