curlyrest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c362bdedaa3523b085c1c85a566d1b4cbaefbe84
+  data.tar.gz: 1156b2fa806226824c715ea4368a5a100fa6e385
+SHA512:
+  metadata.gz: ec71c9ffebea0ffc2285e40832773bc6f03483ffb4ff1210a9573f55a467ea62ead8cd1895a8a15c8abaff826a7eedf5c7168862b90499bd78baab39988165d0
+  data.tar.gz: abb74de66b5520301ce42516f5daa0ca154173fda78eeefe8c1c68a6243c25284693a3482cab25ed91fb5341f333aa01ccb13c9ecd330d2669831da692aa5816

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in curlyrest.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Keith Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Curlyrest
+
+Welcome to curlyrest. In years of testing RESTful APIs, it was regularly beneficial to be able to substitute execution via curl for a request which normally would have been executed with RestClient. This might have been because observation of the exact request wasn't easy, or because RestClient had some unexplained restriction. Having a tool that could execute the request via curl and optionally expose the output, allowed observing the exact failing request. It was also possible to pass the curl request to a colleague without having them deal with environment, ruby, or data complications to be able to replicate a failure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'curlyrest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install curlyrest
+
+## Usage
+
+Simply replace your use of require 'rest-client' with require 'curlyrest', and optionally add header :params of :use_curl with true or 'debug' which will cause the request to be executed with curl and response parsed to be compatable with rest-client.
+
+## Development
+
+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).
+
+## Limitations
+
+Curlyrest works with basic requests, including responses with content-encoding: 'gzip'. I would not be suprised to find some more complicated requests that are not supported at this time.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/keithrw54/curlyrest.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/curlyrest.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'curlyrest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "curlyrest"
+  spec.version       = Curlyrest::VERSION
+  spec.authors       = ["Keith Williams"]
+  spec.email         = ["keithrw@comcast.net"]
+
+  spec.summary       = 'gem extending rest-client, allowing use/debug of curl for request'
+  spec.description   = 'gem extending rest-client, allowing use/debug of curl for request'
+  spec.homepage      = "https://github.com/keithrw54/curlyrest.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "byebug", "~> 2.0"
+end

data/lib/curlyrest.rb

@@ -0,0 +1,91 @@
+require "curlyrest/version"
+require 'rest-client'
+require 'byebug'
+
+module Curlyrest
+  class CurlResponse
+    include Net::HTTPHeader
+    attr_reader :code, :http_version, :message, :headers
+    attr_accessor :body, :inflate
+    def initialize(http_version, status, message)
+      @message = message
+      @http_version = http_version
+      @code = status
+      @body = ''
+      @inflate = Zlib::Inflate.new(32 + Zlib::MAX_WBITS)
+      initialize_http_header nil
+    end
+    def body=(value)
+      @body = value
+    end
+    def unzip_body(gzip)
+      @body = @inflate.inflate(gzip)
+    end
+  end
+
+  def parse_response(r)
+    t = :http_status
+    n = nil
+    body = ''
+    r.each_line do |l|
+      case t
+      when :http_status
+        rem = /^HTTP\/(\d+\.\d+) (\d+) (.+)$/.match(l)
+        n = CurlResponse.new(rem[1], rem[2], rem[3].chop)
+        t = :headers
+      when :headers
+        if /^[\r\n]+$/.match(l)
+          t = :body
+        else
+          rem = /^([\w-]+):\s(.*)/.match(l.chop)
+          n[rem[1]] = rem[2]
+        end 
+      when :body
+        body << l
+      end
+    end
+    if n.to_hash['content-encoding'].include?('gzip')
+      n.unzip_body(body)
+    else
+      n.body = (body)
+    end
+    n
+  end
+
+  def curl_headers(headers)
+    ret_headers = ' '
+    headers.each{|k,v| ret_headers << "-H '#{k}: \"#{v}\"' "}
+    ret_headers
+  end
+
+  def transmit(uri, method, processed_headers, payload, &block)
+    curlyrest_option = processed_headers.delete('Use-Curl')
+    curl_line = "curl -isS -X #{method.upcase} #{curl_headers(processed_headers)}'#{uri}'"
+    puts curl_line if curlyrest_option == 'debug'
+    r = `#{curl_line}`
+    puts r if curlyrest_option == 'debug'
+    parse_response(r)
+  end
+end
+
+include Curlyrest
+
+module RestClient
+  class Request
+    def execute & block
+      # With 2.0.0+, net/http accepts URI objects in requests and handles wrapping
+      # IPv6 addresses in [] for use in the Host request header.
+      case processed_headers['Use-Curl']
+      when 'debug', 'true'
+        r = Curlyrest.transmit(uri, method, processed_headers, payload, &block)
+        RestClient::Response.create(r.body, r, self)
+      else
+        transmit uri, 
+          net_http_request_class(method).new(uri, processed_headers),
+            payload, & block
+      end
+    ensure
+      payload.close if payload
+    end
+  end
+end

data/lib/curlyrest/version.rb

@@ -0,0 +1,3 @@
+module Curlyrest
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: curlyrest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: gem extending rest-client, allowing use/debug of curl for request
+email:
+- keithrw@comcast.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- curlyrest.gemspec
+- lib/curlyrest.rb
+- lib/curlyrest/version.rb
+homepage: https://github.com/keithrw54/curlyrest.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: gem extending rest-client, allowing use/debug of curl for request
+test_files: []