safettp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb5c3ce9fecd9c628c388c8eb29d12e7c0bc4f28
+  data.tar.gz: 6c8de0e8e0899c098f56c74e34ded33fde6d4278
+SHA512:
+  metadata.gz: b164ee8f62159db74d766a821e197a52956db771f35c43cc9455a70a04a4e20b3b20f10ce22dc7d8692ad941d9e98fc39b4a1efdd9903d332b3888e46bdca9a8
+  data.tar.gz: bdb722df61dbb289186c256ae75bcc8d2fe63dc543bc2e65e5247686abcfcf9cb27c8b8ef1082f43612827eff1f6baab392971b5d0de706076545612971222c9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

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 safettp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emric
+
+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,61 @@
+# Safettp
+
+Safettp is another HTTP library. It encourages your requests to always handle
+the failure state, and does so in a straightforward and easy way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safettp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safettp
+
+## Synopsis
+```ruby
+class MyHttpClient
+  include Safettp::Client
+
+  configure do |config|
+    config.base_url = 'https://httpbin.org'
+    config.default_options = { headers: { Accept: 'application/json' } }
+  end
+
+  def do_post(payload, &block)
+    post('/post', payload, &block)
+  end
+end
+
+MyHttpClient.do_post({ body: 'my_body' }) do |result|
+  result.on_success do |response|
+    puts response.parsed_body
+  end
+
+  result.on_failure do |response|
+    puts 'Request failed :c'
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/safettp.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safettp"
+
+# 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/lib/safettp/basic_authenticator.rb

@@ -0,0 +1,11 @@
+class Safettp::BasicAuthenticator
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def set(request)
+    request.basic_auth(options[:username], options[:password])
+  end
+end

data/lib/safettp/client/configuration.rb

@@ -0,0 +1,10 @@
+class Safettp::Client::Configuration
+  attr_accessor :base_url
+  attr_accessor :default_options
+
+  def initialize
+    @default_options = {
+      headers: Safettp::HTTPOptions::DEFAULT_HEADERS
+    }
+  end
+end

data/lib/safettp/client.rb

@@ -0,0 +1,62 @@
+module Safettp::Client
+  attr_reader :base_url, :options_hash
+
+  def initialize(base_url = self.class.config.base_url,
+                 options_hash = self.class.config.default_options)
+    @base_url = base_url
+    @options_hash = options_hash
+  end
+
+  def perform(*args, &block)
+    response = perform_without_guard(*args)
+    guard = Safettp::Guard.new(response)
+    yield(guard)
+    guard.evaluate!
+  end
+
+  def perform_without_guard(method, uri_suffix = '/', options = {})
+    url = "#{base_url}#{uri_suffix}"
+    Safettp::Request.new(url, options_hash.merge(options))
+                    .perform(method)
+  end
+
+  module ClassMethods
+    attr_accessor :config
+
+    def instance_from_default_options
+      new(config.base_url, config.default_options)
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless respond_to_missing?(method, *args, &block)
+      instance_from_default_options.public_send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, *args, &block)
+      instance_from_default_options.respond_to?(method)
+    end
+
+    def configure
+      self.config ||= Safettp::Client::Configuration.new
+      yield(config)
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+
+    %i[get delete].each do |method|
+      define_method(method) do
+        |uri_suffix, query = {}, options = { query: query }, &block|
+        perform(method, uri_suffix, options, &block)
+      end
+    end
+
+    %i[post put patch].each do |method|
+      define_method(method) do
+        |uri_suffix, body = {}, options = { body: body }, &block|
+        perform(method, uri_suffix, options, &block)
+      end
+    end
+  end
+end

data/lib/safettp/error.rb

@@ -0,0 +1,2 @@
+class Safettp::Error < StandardError
+end

data/lib/safettp/guard.rb

@@ -0,0 +1,40 @@
+class Safettp::Guard
+  class Safettp::Guard::StatesNotCovered < Safettp::Error
+  end
+
+  attr_reader :covered, :response
+
+  def initialize(response)
+    @response = response
+    @covered = []
+  end
+
+  def evaluate!
+    return response if safe?
+    raise Safettp::Guard::StatesNotCovered
+  end
+
+  def cover(state, &block)
+    @covered << state
+		yield(response) if response_is?(state)
+  end
+
+  def safe?
+    covered.include?(:success) &&
+      covered.include?(:failure)
+  end
+
+  def on_success(&block)
+    cover(:success, &block)
+  end
+
+  def on_failure(&block)
+    cover(:failure, &block)
+  end
+
+	private
+
+	def response_is?(state)
+		response.public_send("#{state}?")
+	end
+end

data/lib/safettp/http_options.rb

@@ -0,0 +1,39 @@
+class Safettp::HTTPOptions
+  AUTHENTICATORS = {
+    none: Safettp::NoneAuthenticator,
+    basic: Safettp::BasicAuthenticator
+  }.freeze
+
+  DEFAULT_HEADERS = {
+    Accept: 'application/json',
+    'Content-Type': 'application/json'
+  }.freeze
+
+  attr_reader :options_hash
+
+  def initialize(options_hash = {})
+    @options_hash = options_hash
+  end
+
+  def headers
+    options_hash.fetch(:headers, DEFAULT_HEADERS)
+  end
+
+  def parser
+    options_hash.fetch(:parser, Safettp::Parsers::JSON)
+  end
+
+  def query
+    URI.encode_www_form(options_hash.fetch(:query, {}))
+  end
+
+  def body
+    options_hash.fetch(:body, "")
+  end
+
+  def authorization
+    authorization_options = options_hash.fetch(:authorization, { type: :none })
+    AUTHENTICATORS.fetch(authorization_options[:type], Safettp::NoneAuthenticator)
+                  .new(authorization_options)
+  end
+end

data/lib/safettp/none_authenticator.rb

@@ -0,0 +1,11 @@
+class Safettp::NoneAuthenticator
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def set(request)
+    request
+  end
+end

data/lib/safettp/parsers/json.rb

@@ -0,0 +1,11 @@
+class Safettp::Parsers::JSON
+  class << self
+    def encode(raw)
+      JSON.dump(raw)
+    end
+
+    def decode(raw)
+      JSON.parse(raw)
+    end
+  end
+end

data/lib/safettp/parsers.rb

@@ -0,0 +1,2 @@
+module Safettp::Parsers
+end

data/lib/safettp/request/net.rb

@@ -0,0 +1,45 @@
+class Safettp::Request::Net
+  attr_reader :verb, :uri, :options
+
+  def initialize(verb, uri, options)
+    @verb = verb
+    @uri = uri
+    @options = options
+  end
+
+  def perform
+    http.request(request)
+  end
+
+  def http
+    ::Net::HTTP.new(uri.host, uri.port).tap do |obj|
+      obj.use_ssl = uri.scheme == 'https'
+      obj.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+  end
+
+  def request
+    klass = Kernel.const_get("Net::HTTP::#{verb.capitalize}")
+    klass.new(uri).tap do |request|
+      set_headers(request)
+      set_body(request)
+      set_authorization(request)
+    end
+  end
+
+  private
+
+  def set_authorization(request)
+    options.authorization.set(request)
+  end
+
+  def set_body(request)
+    request.body = options.parser.encode(options.body)
+  end
+
+  def set_headers(request)
+    options.headers.each do |header, value|
+      request.add_field(header.to_s, value)
+    end
+  end
+end

data/lib/safettp/request.rb

@@ -0,0 +1,14 @@
+class Safettp::Request
+  attr_reader :uri, :options
+
+  def initialize(uri, options = {})
+    @uri = URI(uri)
+    @options = Safettp::HTTPOptions.new(options)
+    @uri.query = @options.query
+  end
+
+  def perform(method)
+    net = Safettp::Request::Net.new(method, uri, options)
+    Safettp::Response.new(net.perform, options.parser)
+  end
+end

data/lib/safettp/response.rb

@@ -0,0 +1,20 @@
+class Safettp::Response
+  attr_reader :http_response, :parser
+
+  def initialize(http_response, parser = Safettp::Parsers::JSON)
+    @http_response = http_response
+    @parser = parser
+  end
+
+  def success?
+    @http_response.kind_of? Net::HTTPSuccess
+  end
+
+  def failure?
+    !success?
+  end
+
+  def parsed_body
+    parser.decode(http_response.body)
+  end
+end

data/lib/safettp/version.rb

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

data/lib/safettp.rb

@@ -0,0 +1,19 @@
+require 'safettp/version'
+require 'safettp/request'
+require 'safettp/response'
+require 'safettp/request/net'
+require 'safettp/basic_authenticator'
+require 'safettp/none_authenticator'
+require 'safettp/http_options'
+require 'safettp/parsers'
+require 'safettp/parsers/json'
+require 'safettp/client'
+require 'safettp/client/configuration'
+require 'safettp/error'
+require 'safettp/guard'
+require 'json'
+require 'net/http'
+require 'net/https'
+
+module Safettp
+end

data/safettp.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "safettp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "safettp"
+  spec.version       = Safettp::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["emric.mansson@gmail.com"]
+
+  spec.summary       = %q{Simple HTTP library with guarded requests.}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: safettp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: webmock
+  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:
+- emric.mansson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safettp.rb
+- lib/safettp/basic_authenticator.rb
+- lib/safettp/client.rb
+- lib/safettp/client/configuration.rb
+- lib/safettp/error.rb
+- lib/safettp/guard.rb
+- lib/safettp/http_options.rb
+- lib/safettp/none_authenticator.rb
+- lib/safettp/parsers.rb
+- lib/safettp/parsers/json.rb
+- lib/safettp/request.rb
+- lib/safettp/request/net.rb
+- lib/safettp/response.rb
+- lib/safettp/version.rb
+- safettp.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: Simple HTTP library with guarded requests.
+test_files: []