net-hippie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d9dc9b73a1a88cef8f075532f513197d18098be46922c233fc99ba7098313fe
+  data.tar.gz: 662d7a3cdef08349e5dc52c3b1b85418bea07428795a0e0dc8c3adc72542e1f3
+SHA512:
+  metadata.gz: 66ae08e8b6c8c5f3a4f2cb3d50a6fef36731bd5bf37dc230af2fa1ee4fbd7c1cb8d7f3bbc06297e4658f71fd145cfb4b7ddd257a6690212ab9d89e37e0bebb93
+  data.tar.gz: 5f9bd507ef16f2418885d057efb9030709c9423310fb223236a421b48b7cc3b052bdb3e7fadd64d92041de035d2a4957b802511d2dc7a47940d4f12f31dc429a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in net-hippie.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 mo
+
+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,69 @@
+# Net::Hippie
+
+Net::Hippie is a light weight wrapper around `net/http` that defaults to
+sending JSON messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-hippie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-hippie
+
+## Usage
+
+```ruby
+require 'net/hippie'
+
+Net::Hippie.logger = Rails.logger
+
+client = Net::Hippie::Client.new(headers: {
+  'Accept' => 'application/vnd.haveibeenpwned.v2+json'
+})
+
+response = client.get(URI.parse('https://haveibeenpwned.com/api/breaches'))
+
+puts JSON.parse(response.body)
+```
+
+Net::Hippie also supports TLS with client authentication.
+
+```ruby
+client = Net::Hippie::Client.new(
+  certificate: ENV['CLIENT_CERTFICIATE'],
+  key: ENV['CLIENT_KEY']
+)
+```
+
+If your private key is encrypted you may include a passphrase to decrypt it.
+
+```ruby
+client = Net::Hippie::Client.new(
+  certificate: ENV['CLIENT_CERTFICIATE'],
+  key: ENV['CLIENT_KEY'],
+  passphrase: ENV['CLIENT_KEY_PASSPHRASE']
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mokhan/net-hippie.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "net/hippie"
+
+# 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(__FILE__)

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/exe/net-hippie

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "net/hippie"

data/lib/net/hippie.rb

@@ -0,0 +1,20 @@
+require "json"
+require "logger"
+require "net/http"
+require "openssl"
+
+require "net/hippie/version"
+require "net/hippie/json_mapper"
+require "net/hippie/client"
+
+module Net
+  module Hippie
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+  end
+end

data/lib/net/hippie/client.rb

@@ -0,0 +1,86 @@
+module Net
+  module Hippie
+    class Client
+      DEFAULT_HEADERS = {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'User-Agent' => "net/hippie #{Net::Hippie::VERSION}",
+      }
+
+      def initialize(
+        headers: DEFAULT_HEADERS,
+        certificate: nil,
+        key: nil,
+        passphrase: nil,
+        mapper: JsonMapper.new
+      )
+        @certificate = certificate
+        @default_headers = headers
+        @key = key
+        @mapper = mapper
+      end
+
+      def execute(uri, request)
+        http_for(uri).request(request)
+      end
+
+      def get(uri, headers: {}, body: {})
+        request = request_for(Net::HTTP::Get, uri, headers: headers, body: body)
+        response = execute(uri, request)
+        if block_given?
+          yield request, response
+        else
+          response
+        end
+      end
+
+      def post(uri, headers: {}, body: {})
+        request = request_for(Net::HTTP::Post, uri, headers: headers, body: body)
+        response = execute(uri, request)
+        if block_given?
+          yield request, response
+        else
+          response
+        end
+      end
+
+      def put(uri, headers: {}, body: {})
+        request = request_for(Net::HTTP::Put, uri, headers: headers, body: body)
+        response = execute(uri, request)
+        if block_given?
+          yield request, response
+        else
+          response
+        end
+      end
+
+      private
+
+      attr_reader :default_headers
+      attr_reader :certificate, :key, :passphrase
+      attr_reader :mapper
+
+      def http_for(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = 30
+        http.use_ssl = uri.is_a?(URI::HTTPS)
+        http.set_debug_output(Net::Hippie.logger)
+        http.cert = OpenSSL::X509::Certificate.new(certificate) if certificate
+        if key
+          if passphrase
+            http.key = OpenSSL::PKey::RSA.new(key, passphrase)
+          else
+            http.key = OpenSSL::PKey::RSA.new(key)
+          end
+        end
+        http
+      end
+
+      def request_for(type, uri, headers: {}, body: {})
+        type.new(uri, default_headers.merge(headers)).tap do |x|
+          x.body = mapper.map_from(body) unless body.empty?
+        end
+      end
+    end
+  end
+end

data/lib/net/hippie/json_mapper.rb

@@ -0,0 +1,9 @@
+module Net
+  module Hippie
+    class JsonMapper
+      def map_from(hash)
+        JSON.generate(hash)
+      end
+    end
+  end
+end

data/lib/net/hippie/version.rb

@@ -0,0 +1,5 @@
+module Net
+  module Hippie
+    VERSION = "0.1.0"
+  end
+end

data/net-hippie.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "net/hippie/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-hippie"
+  spec.version       = Net::Hippie::VERSION
+  spec.authors       = ["mo"]
+  spec.email         = ["mo@mokhan.ca"]
+
+  spec.summary       = %q{net/http for hippies.}
+  spec.description   = %q{net/http for hippies.}
+  spec.homepage      = "https://www.mokhan.ca/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.4"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: net-hippie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: net/http for hippies.
+email:
+- mo@mokhan.ca
+executables:
+- net-hippie
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/net-hippie
+- lib/net/hippie.rb
+- lib/net/hippie/client.rb
+- lib/net/hippie/json_mapper.rb
+- lib/net/hippie/version.rb
+- net-hippie.gemspec
+homepage: https://www.mokhan.ca/
+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.7.6
+signing_key: 
+specification_version: 4
+summary: net/http for hippies.
+test_files: []