http_api_builder 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bb6287229132caf42b05f3b4fd2d7d0c0886979
+  data.tar.gz: 8dc6d07fa9706a1d3dac2b8342c149e7ca12fc2a
+SHA512:
+  metadata.gz: a96b2a7f66eea0ddc60bf6b66a240658a5ae483ae3958b4e64504dce81354cf8094b509428df12e3cc214cf6e59d462bcb9b648bbd14cd8ac8d142e8959159b8
+  data.tar.gz: 8907e1793fc829b2d3a1cd097090b277e301e527c29c528367cc26260771e4cf25c84f06cb47e8499f4ddc2df7cb41f5b39e4eba34781582f3c3d1c144c1e57a

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  TargetRubyVersion: 2.2
+Metrics/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff Sandberg
+
+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,75 @@
+# HttpApiBuilder
+A simple tool for building API clients that use HTTP.
+
+This is for **clients** as in *consumers*, not for servers. Look into things like Rails-api or Grape for those.
+
+[![Code Climate](https://codeclimate.com/github/paradox460/http_api_builder/badges/gpa.svg)](https://codeclimate.com/github/paradox460/http_api_builder)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_api_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_api_builder
+
+## Usage
+
+```ruby
+require 'http_api_builder/client/http_rb'
+
+class ElGoog < HttpApiBuilder::BaseClient
+  include HttpApiBuilder::Client::HttpRb
+
+  base_url 'https://google.com'
+
+  get '/', as: :search, params: {required: :q}
+end
+```
+
+You can then use the API as such:
+
+```ruby
+g = ElGoog.new
+
+g.search(q: 'ruby')
+```
+
+See the wiki for more details.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff Sandberg
+
+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/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 'http_api_builder'
+
+# 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 'pry'
+Pry.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/http_api_builder.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http_api_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'http_api_builder'
+  spec.version       = HttpApiBuilder::VERSION
+  spec.authors       = ['Jeff Sandberg']
+  spec.email         = ['paradox460@gmail.com']
+
+  spec.summary       = 'A utility gem providing a DSL for building HTTP api wrappers.'
+  spec.description   = 'A gem providing a nice DSL for building HTTP api wrappers.'
+  spec.homepage      = 'https://github.com/paradox460/http_api_builder'
+  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.required_ruby_version = ">= 2.2"
+
+  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 'pry'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'http'
+end

data/lib/http_api_builder/client/http_rb.rb

@@ -0,0 +1,15 @@
+require 'http'
+
+module HttpApiBuilder
+  module Client
+    # A demonstration implementation, using HTTP.rb
+    # This is functional and pretty much production ready, but you can
+    # easily rewrite it to use curb or typhoeus or anything else really
+    module HttpRb
+      def request(verb, path, form:, query:, body:, json:) # rubocop:disable Metrics/ParameterLists
+        url = URI.join(self.class.base_url || '', path)
+        HTTP.send(verb, url, form: form, params: query, body: body, json: json)
+      end
+    end
+  end
+end

data/lib/http_api_builder/dsl.rb

@@ -0,0 +1,95 @@
+require 'forwardable'
+
+module HttpApiBuilder
+  # Module for restful api dsl commands
+  module Dsl
+    VERBS =
+      %i(get head post put delete trace options connect) + # HTTP 1.1
+      %i(propfind proppatch mkcol copy move lock unlock) + # WebDAV
+      %i(orderpatch) + # WebDAV Ordered Collections protocol
+      %i(acl) + # WebDAV Access Control protocol
+      %i(patch) + # PATCH method for HTTP
+      %i(search) # WebDAV search
+
+    # Set the initial URL used by the gem
+    def base_url(value = nil)
+      value.nil? ? @base_url : (@base_url = value)
+    end
+
+    protected
+
+    # Generate whiny and quiet API consumer methods.
+    #
+    # Whiny methods have a bang suffix and raise errors if they fail
+    # Quiet methods do not have the bang suffix and return nil if they fail
+    #
+    # eg:
+    #   endpoint '/path', as: :mymethod
+    # results in:
+    #   mymethod! <-- whiny
+    #   mymethod  <-- quiet
+    def endpoint(path, as:, using: :get, params: nil, form: nil, body: nil, processors: nil, json: nil) # rubocop:disable Metrics/ParameterLists
+      def_whiny_method as, path, using, processors, params, form, body, json
+      def_quiet_method as
+    end
+
+    VERBS.each do |v|
+      define_method v do |path, **opts|
+        consume path, using: v, **opts
+      end
+    end
+
+    private
+
+    # Generate a consumer method that raises exceptions when requests raise an error
+    #
+    def def_whiny_method(name, path, using, processors, params, form, body, json) # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/MethodLength
+      required, optional = requirements(path, params)
+
+      define_method :"#{name}!" do |opts = {}|
+        validate_args! opts.keys, required, optional
+
+        reqpath = interpolate_path(path, opts)
+        query = query_params(path, opts, required, optional)
+
+        form = Hash(form).merge(Hash(opts[:form]))
+        json = opts[:json] || json
+        body = opts[:body] || body
+        perform(using, reqpath, form: form, query: query, body: body, json: json) do |resource, *_|
+          run_processors resource, processors
+        end
+      end
+    end
+
+    # Generate a consumer method that returns nil when requests raise errors
+    #
+    def def_quiet_method(name)
+      define_method name do |opts = {}|
+        begin
+          send(:"#{name}!", opts)
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    # Extract param segments from a path, paperclip style. Returns an array of symbols matching the names of the param segments.
+    #
+    # Param segments are sections of the path that begin with `:`, and run to the next /
+    def interpolated_params(path)
+      path.split('/').reject { |i| i.length.zero? || i !~ /^:/ }.uniq.map { |i| i[1..-1].to_sym }
+    end
+
+    # Parse out and return the required and optional arguments
+    #
+    # Required are any that are in the URL or in the required hash
+    # Optional are any other arguments.
+    def requirements(path, params)
+      required, optional = Hash(params).values_at(*%i(required optional)).map { |list| Array(list) }
+
+      required += interpolated_params(path)
+
+      [required, optional]
+    end
+  end
+end

data/lib/http_api_builder/helpers.rb

@@ -0,0 +1,75 @@
+module HttpApiBuilder
+  # Helper methods
+  module Helpers
+    protected
+
+    # Validates arguments and ensures that required and optional are present.
+    # Also validates that all args are expected
+    #
+    # @param [Array] actual The args (or keys of args) we've received
+    # @param [Array] required Args we are required to have, will raise error if not present
+    # @param [Array] optional Optional args.
+    def validate_args!(actual, required, optional)
+      validate_required_arguments(actual, required)
+      validate_valid_arguments(actual, required, optional)
+    end
+
+    private
+
+    # Start the processing chain for the response object
+    # Processors work in a chain, meaning order of operations is important.
+    # The first processor gets the raw result, the second processor the first's
+    # output and so forth.
+    # The last processor's output is the return of the method
+    # processors: [processor1, processor2] yields this pipeline:
+    # request -> processor1 -> processor2 -> output
+    def run_processors(resource, processors)
+      Array(processors).reduce(resource) do |data, processor|
+        if processor.respond_to?(:call)
+          processor.call(data)
+        else
+          send(processor, data)
+        end
+      end
+    end
+
+    # Build the path, filling in any interpolation tokens
+    #
+    # @param [String] path
+    # @param [Hash] values Key-value {interpolation: value}
+    # @return [String] interpolated string
+    def interpolate_path(path, values)
+      result = path.dup
+      values.each do |token, value|
+        token = ":#{token}"
+        result.gsub!(token, value)
+      end
+      result
+    end
+
+    # Get the non-interpolating query parameters
+    def query_params(path, params, required, optional)
+      path_params = self.class.send(:interpolated_params, path)
+      query_keys  = (required + (optional - [:data])) - path_params
+      params.select { |k, _| query_keys.include? k }
+    end
+
+    # Raise an ArgumentError if not everything listed as required is not listed in supplied.
+    #
+    def validate_required_arguments(supplied, required)
+      missing = supplied & required
+      return if missing.sort == required.sort
+
+      raise ArgumentError, "missing required arguments: #{missing.join(', ')}"
+    end
+
+    # Raise an ArgumentError if not everything listed in supplied appear in either the required or optional list.
+    #
+    def validate_valid_arguments(supplied, required, optional)
+      unrecognized = supplied - (required + optional).uniq
+      return if unrecognized.empty?
+
+      raise ArgumentError, "unrecognized arguments: #{unrecognized.join(', ')}"
+    end
+  end
+end

data/lib/http_api_builder/version.rb

@@ -0,0 +1,3 @@
+module HttpApiBuilder
+  VERSION = '0.2.0'.freeze
+end

data/lib/http_api_builder.rb

@@ -0,0 +1,34 @@
+require 'http_api_builder/version'
+require 'http_api_builder/dsl'
+require 'http_api_builder/helpers'
+
+module HttpApiBuilder
+  # A basic HTTP client. Meant to be extended from.
+  class BaseClient
+    extend Dsl
+    include Helpers
+
+    def initialize(); end
+
+    # Perform the request, post processors, and return the result
+    def perform(method, path, form: nil, query: nil, body: nil, json: nil, &_block) # rubocop:disable Metrics/ParameterLists
+      response = request(method, path, form: form, query: query, body: body, json: json)
+      status = response.status
+      resource = response.body
+      block_given? ? yield(resource, status, response) : resource
+    end
+
+    # Placeholder for your request method.
+    # Accepts these params, for you to do whatever you like with. See the HTTPrb_client implementation
+    #
+    # @param [Symbol] method The HTTP VERB to use
+    # @param [String, URI] path The path, excluding base_url, which should be prepended inside your implementation
+    # @param [Hash] form: nil Form data, for encoding into HTTP form encoding
+    # @param [Hash] query: nil Query key/value pairs
+    # @param [String] body: nil A raw body
+    # @param [Hash, Array] json: nil Hash/Array data to be encoded as JSON.
+    def request(*)
+      raise 'HttpApiBuilder::BaseClient#request must be implemented, see documentation'
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: http_api_builder
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jeff Sandberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-05 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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: http
+  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: A gem providing a nice DSL for building HTTP api wrappers.
+email:
+- paradox460@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- http_api_builder.gemspec
+- lib/http_api_builder.rb
+- lib/http_api_builder/client/http_rb.rb
+- lib/http_api_builder/dsl.rb
+- lib/http_api_builder/helpers.rb
+- lib/http_api_builder/version.rb
+homepage: https://github.com/paradox460/http_api_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+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: A utility gem providing a DSL for building HTTP api wrappers.
+test_files: []