curl-spawn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7676051058f1b4763f5a22e603b71561f1ccb6b3
+  data.tar.gz: 8f1a5765a4d41861aaa1660801e1e0c55c19f1af
+SHA512:
+  metadata.gz: a50aed177c4f47f3a0fb3e93ed3c170f5a9d29c9f5f89747a995cb742bfe4aae4dc904a49af982651a367b65d9e93ddd0a4dd76e27c72c43d49b0f9ad4c60eeb
+  data.tar.gz: 0fa807255c489c528d8d479fdbf4288aa7648d36ef6ba31bc82fb63577c5dffa6d1f2c431b7304a7ed2be65ec05371a748f4a82b77bd81628f96cc8e2befce68

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 jbreeden
+
+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,97 @@
+# curl-spawn
+
+Simple DSL for invoking curl commands. Includes a script generator - `curl-spawn-generate` -
+and an interactive shell - `curl-spawn-irb`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'curl-spawn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install curl-spawn
+
+## Usage
+
+### Ruby API
+
+`curl-spawn-irb` will show a short API example at startup.
+At the time of this writing, it looks like this:
+
+```Sh
+[jared:~/projects/curl-spawn] curl-spawn-irb
+--------------------
+Welcome to curl-spawn-irb!
+
+This is an interactive ruby shell with curl-spawn loaded.
+Here, you can spawn curl processes with a convenient ruby DSL.
+
+Example:
+
+  # - The block is executed in the context of a Curl::Spawn::ArgsBuilder, which
+  #   provides a DSL for describing curl commands.
+  #
+  # - Any parameters to `Curl.spawn` are merged with the arguments derived
+  #   from the DSL block, then passed through to `Kernel.spawn` when invoking curl.
+  #   (Arguments derived from the block are preferred in case of conflicts.)
+  #
+  #   + You can use this to set positional arguments, redirect stdin/stdout/stderr,
+  #     and a few other things. (Note: the env hash argument to `Kernel.spawn` is
+  #     not supported through this api.)
+
+  pid = Curl.spawn('--progress-bar', out: $stdout, err: $stderr) {
+    https                   # Use https. Same as `scheme 'https'`. (default: http)
+    ssl_no_verify           # Don't verify ssl certs. (Primarily for development)
+
+    user $opt[:user] if $opt[:user]         # Set the username to use in basic auth
+    password 'abcd1234'     # Set the password to use for basic auth
+
+    verb :post              # Set the http method/verb (default: 'GET')
+    host 'localhost'        # Specify host (default: 'localhost')
+    port 8000               # On port 8000 (default: 80)
+    path '/'                # The path segment of the url (default: '/')
+
+    query :param => Curl.url_encode('value') # Set query params (alias: queries)
+    header :Accept => 'application/json'     # Set headers (alias: headers)
+
+    content $stdin          # IO object or string to use as the request content.
+                            # Note that this option overwrite the `:in` option
+                            # from the positional arguments to this method.
+
+    # For debugging, you can print out the generated Curl::Spawn::Args object
+    $stderr.puts build!.inspect
+  }
+--------------------
+[1] pry(main)>
+```
+
+### Shell Scripts
+
+The main reason for writing this gem was to ease the task of writing small
+shell scripts whose main function is using curl to hit a REST endpoint.
+So the `curl-spawn-generate` command is provided, which generates just
+such a script.
+
+`curl-spawn-generate > `[example.rb](./example.rb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jbreeden/curl-spawn.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "curl/spawn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/curl-spawn.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'curl/spawn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "curl-spawn"
+  spec.version       = Curl::Spawn::VERSION
+  spec.authors       = ["jbreeden"]
+  spec.email         = ["jared.breeden@gmail.com"]
+
+  spec.summary       = %q{Utilities for spawning curl processes}
+  spec.homepage      = "http://github.com/jbreeden/curl-spawn"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

data/example.rb

@@ -0,0 +1,109 @@
+#! /usr/bin/env ruby
+
+require 'curl/spawn'
+
+# User Manual
+# -----------
+
+def help(status = 0)
+  puts <<-EOS
+Usage:
+  #{File.basename(__FILE__)} [[--]help] [OPTION...] -- [CURL_ARG...]
+
+OPTION:
+  -u,--user=USER[:PASSWORD]
+    Username & optional password to authenticate with.
+
+  -h,--host=HOST
+    The host to send the request to (default: localhost).
+
+  -p,--port=PORT
+    The port to send the request to (default: 80).
+
+  -c,--content=FILENAME
+    The file to send as the request body. If FILENAME is a hyphen (-), then
+    stdin is used.
+
+CURL_ARG:
+  Any additional arguments after a -- are passed straight through to curl.
+EOS
+  exit status
+end
+
+# Argument Parsing
+# ----------------
+
+$opt = {
+  user: nil,
+  password: nil,
+  host: 'localhost',
+  port: 80,
+  content: nil
+}
+
+in_curl_args = false
+curl_args = []
+ARGV.dup.each do |arg|
+  if !in_curl_args
+    case arg
+    when '--help', 'help'
+      help(0)
+    when /^(?:-u|--user)=?(.*)$/
+      $opt[:user], $opt[:password] = $1.match(/([^:]*):?(.*)/).captures
+      ARGV.delete(arg)
+    when /^(?:-h|--host)=?(.*)$/
+      $opt[:host] = $1
+      ARGV.delete(arg)
+    when /^(?:-p|--port)=?(.*)$/
+      $opt[:port] = $1
+      ARGV.delete(arg)
+    when /^(?:-c|--content)=?(.*)$/
+      prev = $opt[:content]
+      prev.close if prev && prev != $stdin
+      if $1 == '-'
+        $opt[:content] = $stdin
+      else
+        $opt[:content] = File.open($1, 'r')
+      end
+      ARGV.delete(arg)
+    when '--'
+      in_curl_args = true
+      ARGV.delete(arg)
+    end
+  else
+    curl_args.push(arg)
+    ARGV.delete(arg)
+  end
+end
+
+if !ARGV.empty?
+  $stderr.puts "Unexpected arguments: #{ARGV.inspect}"
+  help(1)
+end
+
+# Curl Invocation
+# ---------------
+
+pid = Curl.spawn(*curl_args, out: $stdout, err: $stderr) {
+  https
+  ssl_no_verify
+
+  user $opt[:user] unless $opt[:user].nil? || $opt[:user].empty?
+  password $opt[:password] unless $opt[:password].nil? || $opt[:password].empty?
+
+  verb 'POST'
+  host $opt[:host]
+  port $opt[:port]
+  path '/'
+
+  header 'Content-Type' => 'application/json'
+  header 'Accept' => 'application/json'
+
+  content $opt[:content] if $opt[:content]
+
+  # # Debug:
+  # $stderr.puts build!.inspect
+}
+
+Process.wait(pid)
+exit $?.exitstatus

data/exe/curl-spawn-generate

@@ -0,0 +1,3 @@
+#! /usr/bin/env ruby
+require 'curl/spawn/example'
+puts Curl::Spawn::EXAMPLE_SCRIPT

data/exe/curl-spawn-irb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'curl/spawn'
+require 'curl/spawn/example'
+
+welcome = <<-eos
+--------------------
+Welcome to curl-spawn-irb!
+
+This is an interactive ruby shell with curl-spawn loaded.
+Here, you can spawn curl processes with a convenient ruby DSL.
+
+Example: ```
+
+#{Curl::Spawn::EXAMPLE.each_line.map { |l| "  #{l}"}.join("")}
+
+```
+--------------------
+eos
+
+begin
+  require 'pry'
+  puts welcome
+  self.pry
+rescue Exception => ex
+  $stderr.puts "Tip: `gem install pry` for a nicer shell."
+  puts welcome
+  require 'irb'
+  IRB.start
+end

data/lib/curl/spawn/args.rb

@@ -0,0 +1,15 @@
+module Curl
+module Spawn
+
+  class Args
+    attr_accessor :argv, :env, :opt
+
+    def initialize()
+      @argv = []
+      @env = {}
+      @opt = {}
+    end
+  end
+
+end
+end

data/lib/curl/spawn/args_builder.rb

@@ -0,0 +1,131 @@
+require 'erb'
+require 'curl/spawn/args'
+
+module Curl
+module Spawn
+
+  class ArgsBuilder
+    def initialize
+      @user = nil
+      @password = nil
+      @scheme = 'http'
+      @ssl_no_verify = false
+      @host = 'localhost'
+      @port = 80
+      @path = '/'
+      @verb = 'GET'
+      @queries = {}
+      @headers = {}
+      @data = nil
+    end
+
+    def user(user)
+      @user = user
+    end
+    alias user= user
+    alias username user
+    alias username= user
+
+    def password(p)
+      @password = p
+    end
+    alias password= password
+
+    def scheme(h)
+      @scheme = h
+    end
+    alias scheme= scheme
+
+    def http
+      @scheme = 'http'
+    end
+
+    def https
+      @scheme = 'https'
+    end
+
+    def ssl_no_verify(val = true)
+      @ssl_no_verify = val
+    end
+    alias ssl_no_verify= ssl_no_verify
+
+    def host(h)
+      @host = h
+    end
+    alias host= host
+
+    def port(p)
+      @port = p
+    end
+    alias port= port
+
+    def path(p)
+      p = "/#{p}" unless p.start_with?('/')
+      @path = p
+    end
+    alias path= path
+
+    def verb(v)
+      @verb = v
+    end
+    alias verb= verb
+
+    def query(q)
+      @queries.merge!(q)
+    end
+    alias queries query
+
+    def header(h)
+      @headers.merge!(h)
+    end
+    alias headers header
+
+    def data(d)
+      @data =d
+    end
+    alias data= data
+    alias content data
+    alias content= data
+
+    def build!
+      args = ::Curl::Spawn::Args.new
+
+      args.argv.push('curl')
+      args.argv.push('-k') if @ssl_no_verify
+      args.argv.push('--user') unless @user.nil?
+      args.argv.push("#{@user}#{":#{@password}" unless @password.nil?}")
+
+      query_str = ''
+      @queries.each do |k, v|
+        if query_str == ''
+          query_str << '?'
+        else
+          query_str << '&'
+        end
+        query_str << "#{ERB::Util.url_encode(k)}=#{ERB::Util.url_encode(v)}"
+      end
+
+      args.argv.push('-X')
+      args.argv.push(@verb.upcase)
+
+      args.argv.push("#{@scheme}://#{@host}:#{@port}#{@path}#{query_str}")
+
+      @headers.each do |k, v|
+        args.argv.push("-H")
+        args.argv.push("'#{k}: #{v}'")
+      end
+
+      if @data
+        args.argv.push('--data-binary')
+        args.argv.push('@-')
+        args.opt[:in] = @data
+      end
+
+      args.argv = args.argv.reject { |arg| arg.nil? || arg.empty? }.map { |arg| arg.to_s }
+
+      args
+    end
+  end
+
+end
+end

data/lib/curl/spawn/example.rb

@@ -0,0 +1,153 @@
+module Curl
+module Spawn
+
+  EXAMPLE = <<-eos
+# - The block is executed in the context of a Curl::Spawn::ArgsBuilder, which
+#   provides a DSL for describing curl commands.
+#
+# - Any parameters to `Curl.spawn` are merged with the arguments derived
+#   from the DSL block, then passed through to `Kernel.spawn` when invoking curl.
+#   (Arguments derived from the block are preferred in case of conflicts.)
+#
+#   + You can use this to set positional arguments, redirect stdin/stdout/stderr,
+#     and a few other things. (Note: the env hash argument to `Kernel.spawn` is
+#     not supported through this api.)
+
+pid = Curl.spawn('--progress-bar', out: $stdout, err: $stderr) {
+  https                   # Use https. Same as `scheme 'https'`. (default: http)
+  ssl_no_verify           # Don't verify ssl certs. (Primarily for development)
+
+  user $opt[:user] if $opt[:user]  # Set the username to use for authentication
+  password 'abcd1234'              # Set the password to use for authentication
+
+  verb :post              # Set the http method/verb (default: 'GET')
+  host 'localhost'        # Specify host (default: 'localhost')
+  port 8000               # On port 8000 (default: 80)
+  path '/'                # The path segment of the url (default: '/')
+
+  query :param => Curl.url_encode('value') # Set query params (alias: queries)
+  header :Accept => 'application/json'     # Set headers (alias: headers)
+
+  content $stdin          # IO object or string to use as the request content.
+                          # Note that this option overwrite the `:in` option
+                          # from the positional arguments to this method.
+
+  # For debugging, you can print out the generated Curl::Spawn::Args object
+  $stderr.puts build!.inspect
+}
+eos
+
+  EXAMPLE_SCRIPT = <<-eos
+#! /usr/bin/env ruby
+
+require 'curl/spawn'
+
+# User Manual
+# -----------
+
+def help(status = 0)
+  puts <<-EOS
+Usage:
+  \#{File.basename(__FILE__)} [[--]help] [OPTION...] -- [CURL_ARG...]
+
+OPTION:
+  -u,--user=USER[:PASSWORD]
+    Username & optional password to authenticate with.
+
+  -h,--host=HOST
+    The host to send the request to (default: localhost).
+
+  -p,--port=PORT
+    The port to send the request to (default: 80).
+
+  -c,--content=FILENAME
+    The file to send as the request body. If FILENAME is a hyphen (-), then
+    stdin is used.
+
+CURL_ARG:
+  Any additional arguments after a -- are passed straight through to curl.
+EOS
+  exit status
+end
+
+# Argument Parsing
+# ----------------
+
+$opt = {
+  user: nil,
+  password: nil,
+  host: 'localhost',
+  port: 80,
+  content: nil
+}
+
+in_curl_args = false
+curl_args = []
+ARGV.dup.each do |arg|
+  if !in_curl_args
+    case arg
+    when '--help', 'help'
+      help(0)
+    when /^(?:-u|--user)=?(.*)$/
+      $opt[:user], $opt[:password] = $1.match(/([^:]*):?(.*)/).captures
+      ARGV.delete(arg)
+    when /^(?:-h|--host)=?(.*)$/
+      $opt[:host] = $1
+      ARGV.delete(arg)
+    when /^(?:-p|--port)=?(.*)$/
+      $opt[:port] = $1
+      ARGV.delete(arg)
+    when /^(?:-c|--content)=?(.*)$/
+      prev = $opt[:content]
+      prev.close if prev && prev != $stdin
+      if $1 == '-'
+        $opt[:content] = $stdin
+      else
+        $opt[:content] = File.open($1, 'r')
+      end
+      ARGV.delete(arg)
+    when '--'
+      in_curl_args = true
+      ARGV.delete(arg)
+    end
+  else
+    curl_args.push(arg)
+    ARGV.delete(arg)
+  end
+end
+
+if !ARGV.empty?
+  $stderr.puts "Unexpected arguments: \#{ARGV.inspect}"
+  help(1)
+end
+
+# Curl Invocation
+# ---------------
+
+pid = Curl.spawn(*curl_args, out: $stdout, err: $stderr) {
+  https
+  ssl_no_verify
+
+  user $opt[:user] unless $opt[:user].nil? || $opt[:user].empty?
+  password $opt[:password] unless $opt[:password].nil? || $opt[:password].empty?
+
+  verb 'POST'
+  host $opt[:host]
+  port $opt[:port]
+  path '/'
+
+  header 'Content-Type' => 'application/json'
+  header 'Accept' => 'application/json'
+
+  content $opt[:content] if $opt[:content]
+
+  # # Debug:
+  # $stderr.puts build!.inspect
+}
+
+Process.wait(pid)
+exit $?.exitstatus
+eos
+
+end
+end

data/lib/curl/spawn/version.rb

@@ -0,0 +1,5 @@
+module Curl
+  module Spawn
+    VERSION = "0.1.0"
+  end
+end

data/lib/curl/spawn.rb

@@ -0,0 +1,39 @@
+require "curl/spawn/version"
+require "curl/spawn/args_builder"
+require 'erb'
+
+module Curl
+  module Spawn
+    def self.build_args(&block)
+      builder = ArgsBuilder.new
+      builder.instance_eval(&block) if block
+      builder.build!
+    end
+  end
+
+  def self.spawn(*supplied_argv, &block)
+    built_args = Curl::Spawn.build_args(&block)
+
+    normalized_argv = []
+
+    supplied_opt = supplied_argv.last.kind_of?(Hash) ? supplied_argv.pop : {}
+
+    # Merge the argv contents
+    built_args.argv.each do |arg|
+      normalized_argv.push(arg.to_s)
+    end
+
+    supplied_argv.each do |arg|
+      normalized_argv.push(arg.to_s)
+    end
+
+    # Merge the spawn options hash argument
+    normalized_argv.push(supplied_opt.merge(built_args.opt))
+
+    Kernel.spawn(*normalized_argv)
+  end
+
+  def self.url_encode(str)
+    ERB::Util.url_encode(str)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: curl-spawn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jbreeden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jared.breeden@gmail.com
+executables:
+- curl-spawn-generate
+- curl-spawn-irb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- curl-spawn.gemspec
+- example.rb
+- exe/curl-spawn-generate
+- exe/curl-spawn-irb
+- lib/curl/spawn.rb
+- lib/curl/spawn/args.rb
+- lib/curl/spawn/args_builder.rb
+- lib/curl/spawn/example.rb
+- lib/curl/spawn/version.rb
+homepage: http://github.com/jbreeden/curl-spawn
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Utilities for spawning curl processes
+test_files: []
+has_rdoc: