unrest 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a863008615e62441c65cd2fc7c729f2a8d52b279
+  data.tar.gz: ce3e716c37c0f88215171813a2752d2c8469e4ca
+SHA512:
+  metadata.gz: d2a857691424f87d618dd2785ffd9e9892b062bee8d4a4d3b0fb48d920c5700e730d13c28796ad230348f04505e599e221ba5d591464785dc01e9d3897bf6dcc
+  data.tar.gz: 1a136bbbc6a0929bd9ae584d384ce39424c10457c6c35af916f89f96789bd76393a4d633a4243c3b26f330be8d908ccf9bb7fa4fa33d042469aa52178b062fdc

data/.gitignore

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

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.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Steven Eksteen
+
+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,71 @@
+# unReST
+
+[![Gem Version](https://badge.fury.io/rb/unrest.svg)](https://badge.fury.io/rb/unrest)
+[![Build Status](https://travis-ci.org/eksoverzero/unrest.svg)](https://travis-ci.org/eksoverzero/unrest)
+
+To build very quick little API clients for legacy or tiny APIs with no existing gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unrest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unrest
+
+## Usage
+
+unReST works by using files of request templates, and their directory structure, to dynamically build the API client.
+
+Setting up a project like this, for example:
+
+```
+.
++-- example.rb
++-- ip.html
++-- image
+|   +-- png.xml
+|   +-- svg.html
+|   +-- jpeg.json
+|   +-- webp.text
+```
+
+This will generate an API client with access to the follwoing endpoints/methods:
+
+```
+# example.rb
+require('unrest')
+
+client = Unrest.new('https://httpbin.org')
+```
+
+- `client.ip`: https://httpbin.org/ip
+- `client.image_png`: https://httpbin.org/image/png
+- `client.image_svg`: https://httpbin.org/image/svg
+- `client.image_jpeg`: https://httpbin.org/image/jpeg
+- `client.image_webp`: https://httpbin.org/image/webp
+
+The file extentions: `xml`, `html`, `json` and `text` will be used against the API and the results formatted accordingly. Since, in the exampe, we will be sending nothing to the API- these files can be empty. 
+
+## 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/eksoverzero/unrest.
+
+
+## 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 "unrest"
+
+# 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/example/example.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'unrest'
+
+client = Unrest.new('http://example.com')

data/example/path/json/file.json

@@ -0,0 +1,8 @@
+{
+  "note": {
+    "to": "{{note.to}}",
+    "from": "{{note.from}}",
+    "heading": "{{note.heading}}",
+    "body": "{{note.body}}"
+  }
+}

data/example/path/xml/file.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<note>
+  <to>{{note.to}}</to>
+  <from>{{note.from}}</from>
+  <heading>{{note.heading}}</heading>
+  <body>{{note.body}}</body>
+</note>

data/lib/hash_recursive_merge.rb

@@ -0,0 +1,74 @@
+#
+# = Hash Recursive Merge
+#
+# Merges a Ruby Hash recursively, Also known as deep merge.
+# Recursive version of Hash#merge and Hash#merge!.
+#
+# Category::    Ruby
+# Package::     Hash
+# Author::      Simone Carletti <weppos@weppos.net>
+# Copyright::   2007-2008 The Authors
+# License::     MIT License
+# Link::        http://www.simonecarletti.com/
+# Source::      http://gist.github.com/gists/6391/
+#
+module HashRecursiveMerge
+
+  #
+  # Recursive version of Hash#merge!
+  #
+  # Adds the contents of +other_hash+ to +hsh+,
+  # merging entries in +hsh+ with duplicate keys with those from +other_hash+.
+  #
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  #
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge!(h2)   #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #
+  # Simply using Hash#merge! would return
+  #
+  #    h1.merge!(h2)    #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  #
+  def rmerge!(other_hash)
+    merge!(other_hash) do |key, oldval, newval|
+      oldval.class == self.class ? oldval.rmerge!(newval) : newval
+    end
+  end
+
+  #
+  # Recursive version of Hash#merge
+  #
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  #
+  # Compared with Hash#merge, this method provides a different approch
+  # for merging nasted hashes.
+  # If the value of a given key is an Hash and both +other_hash+ abd +hsh
+  # includes the same key, the value is merged instead replaced with
+  # +other_hash+ value.
+  #
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge(h2)    #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #
+  # Simply using Hash#merge would return
+  #
+  #    h1.merge(h2)     #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  #
+  def rmerge(other_hash)
+    r = {}
+    merge(other_hash) do |key, oldval, newval|
+      r[key] = oldval.class == self.class ? oldval.rmerge(newval) : newval
+    end
+  end
+
+end
+
+
+class Hash
+  include HashRecursiveMerge
+end

data/lib/unrest/configuration.rb

@@ -0,0 +1,70 @@
+require 'singleton'
+require 'unrest/configuration_hash'
+
+class Unrest
+  def self.configure(options = nil, &block)
+    if !options.nil?
+      Configuration.instance.configure(options)
+    end
+  end
+
+  def self.config
+    Configuration.instance.data
+  end
+
+  class Configuration
+    include Singleton
+
+    OPTIONS = [
+      :https,
+      :timeout,
+      :headers,
+      :parameters,
+      :authentication
+    ]
+
+    attr_accessor :data
+
+    def self.set_defaults
+      instance.set_defaults
+    end
+
+    OPTIONS.each do |o|
+      define_method o do
+        @data[o]
+      end
+      define_method "#{o}=" do |value|
+        @data[o] = value
+      end
+    end
+
+    def configure(options)
+      @data.rmerge!(options)
+    end
+
+    def initialize
+      @data = Unrest::ConfigurationHash.new
+      set_defaults
+    end
+
+    def set_defaults
+      @data[:https] = false
+      @data[:timeout] = 5
+      @data[:headers] = {}
+      @data[:parameters] = {}
+      @data[:authentication] = {}
+    end
+
+    instance_eval(OPTIONS.map do |option|
+      o = option.to_s
+      <<-EOS
+      def #{o}
+        instance.data[:#{o}]
+      end
+      def #{o}=(value)
+        instance.data[:#{o}] = value
+      end
+      EOS
+    end.join("\n\n"))
+  end
+end

data/lib/unrest/configuration_hash.rb

@@ -0,0 +1,11 @@
+require 'hash_recursive_merge'
+
+class Unrest
+  class ConfigurationHash < Hash
+    include HashRecursiveMerge
+
+    def method_missing(meth, *args, &block)
+      has_key?(meth) ? self[meth] : super
+    end
+  end
+end

data/lib/unrest/exceptions.rb

@@ -0,0 +1,15 @@
+require 'timeout'
+
+class Unrest
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+  
+  class RequestTimeout < Error
+  end
+  
+  class NetworkError < Error
+  end
+end

data/lib/unrest/version.rb

@@ -0,0 +1,3 @@
+class Unrest
+  VERSION = "0.1.1"
+end

data/lib/unrest.rb

@@ -0,0 +1,136 @@
+require 'unrest/version'
+require 'unrest/exceptions'
+require 'unrest/configuration'
+
+require 'uri'
+require 'liquid'
+require 'net/http'
+require 'pathname'
+require 'active_support'
+require 'active_support/core_ext/hash/keys'
+
+class Unrest
+  FILE_TYPES = ['.xml', '.html', '.json', '.text']
+
+  attr_accessor :url, :args
+
+  def initialize url, **args
+    @url = url
+    @args = args.deep_symbolize_keys
+    @options = @args[:options]
+    @arguments = @args[:arguments]
+
+    call = caller_locations.first.absolute_path
+    files = Dir[File.join(File.dirname(call), '**', '*') ]
+            .reject{ |path| File.directory? path }
+            .reject{ |file| !Unrest::FILE_TYPES.include?(File.extname(file))}
+
+    files.each do |file|
+      path = Pathname.new(file).relative_path_from(Pathname.new(call))
+      path = path.to_s[0..-(File.extname(path).length + 1)].split('/')[1..-1]
+
+      Unrest.class_eval do
+        define_method path.join('_').downcase do |args|
+          args.deep_symbolize_keys!
+
+          http_request(file, path.join('/'),
+             (@options.merge(args[:options]) rescue @options),
+             (@arguments.merge(args[:arguments]) rescue @arguments)
+          )
+        end
+      end
+    end
+  end
+
+  private
+
+  def uri path=nil
+    URI.parse([url, path].compact.join('/'))
+  end
+
+  def ssl? uri
+    uri.scheme.casecmp('https') == 0
+  end
+
+  def http_client uri
+    http_client = Net::HTTP.new uri.host, uri.port
+
+    http_client.use_ssl = ssl?(uri)
+    http_client.open_timeout = configuration.timeout
+    http_client.read_timeout = configuration.timeout
+    http_client.set_debug_output($stdout)
+
+    http_client
+  end
+
+  def http_request file, path, options={}, arguments={}
+    uri = uri(path)
+    http_request = http_request_method(options[:http_request_method]).new uri.path
+
+    if configuration.authentication[:username] and configuration.authentication[:password]
+      http_request.basic_auth(
+        configuration.authentication[:username],
+        configuration.authentication[:password]
+      )
+    end
+
+    http_request_headers = options[:http_request_headers] || {}
+
+    http_request_headers.merge(http_request_headers(File.extname(file))).each do |attribute, value|
+      http_request[attribute] = value
+    end
+
+    http_request.body = http_request_body file, arguments
+
+    http_client(uri).request http_request
+  rescue Timeout::Error
+    raise Unrest::RequestTimeout
+  rescue Errno::EHOSTUNREACH, Errno::ETIMEDOUT, Errno::ENETUNREACH
+    raise Unrest::NetworkError
+  end
+
+  def http_request_body file, arguments={}
+    template = Liquid::Template.parse(File.read(file))
+    template.render(arguments.deep_stringify_keys)
+  end
+
+  def http_request_format extention
+    case extention
+    when '.xml'
+      http_request_format = 'text/xml'
+    when 'html'
+      http_request_format = 'text/html'
+    when 'json'
+      http_request_format = 'text/json'
+    else
+      http_request_format = 'text/plain'
+    end
+
+    { 'Content-Type' => http_request_format }
+  end
+
+  def http_request_method method='get'
+    case method
+    when 'get'
+      Net::HTTP::Get
+    when 'put'
+      Net::HTTP::Put
+    when 'post'
+      Net::HTTP::Post
+    when 'patch'
+      Net::HTTP::Patch
+    when 'delete'
+      Net::HTTP::Delete
+    else
+      raise Unrest::ConfigurationError
+    end
+  end
+
+  def http_request_headers extention=nil
+    configuration.headers.merge(http_request_format(extention))
+  end
+
+  def configuration
+    Unrest.config
+  end
+end

data/unrest.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unrest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unrest"
+  spec.version       = Unrest::VERSION
+  spec.authors       = ["Steven Eksteen"]
+  spec.email         = ["steven@secondimpression.net"]
+
+  spec.summary       = %q{unReSTful API client}
+  spec.homepage      = "https://github.com/eksoverzero/unrest"
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_runtime_dependency "liquid"
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "activesupport", "~> 5.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: unrest
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Steven Eksteen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+description: 
+email:
+- steven@secondimpression.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/example.rb
+- example/path/json/file.json
+- example/path/xml/file.xml
+- lib/hash_recursive_merge.rb
+- lib/unrest.rb
+- lib/unrest/configuration.rb
+- lib/unrest/configuration_hash.rb
+- lib/unrest/exceptions.rb
+- lib/unrest/version.rb
+- unrest.gemspec
+homepage: https://github.com/eksoverzero/unrest
+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.1
+signing_key: 
+specification_version: 4
+summary: unReSTful API client
+test_files: []